algorithmiaio/api-docs

Algorithmia API Documentation

This repository houses the documentation for Algorithmia's API.

Getting Started

Local Development

The Easy Way

docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate:v2.8.0 serve

The Manual Way

First, ensure you have Ruby 2.7.2 installed on your system. Then, with the repository as your active working directory, run the following to install necessary packages:

bundle install

If Ruby is already installed, but the bundle install command doesn't work, just run gem install bundler and try the above command once more.

Then run the following to fire up a development server:

bundle exec middleman server

And voila! Your development server is available at localhost:4567, and will automatically update with any changes you make.

Building for Production

The Easy Way

docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate:v2.8.0

The Manual Way

To build the static assets for this documentation, simply run:

bundle exec middleman build --clean

A build directory will be created that contains all of the production-ready static assets for this documentation.

Contributing

Want to add documentation for a new API resource or endpoint? Huzzah! Follow this checklist to ensure you add all of the necessary information.

If you're adding a new resource

• First, create a new file in source/includes specifically for your resource. Title it _${resource_name}, e.g. _users.md, _organization_members.md, etc...
• Add the name of this file to the includes section at the top of index.html.md file. Alphabetical ordering please!
• Within your new file, add a section to the top that fully describes the resource and the properties it might possess. For an example, take a look at the _algorithms.md file: it possesses a section titled "The algorithm object" which describes every property an algorithm object might possess.
• For each property, provide the name of the property (for nested properties use dot notation, e.g. obj1.property), the data type, and a description of the property.
• For each endpoint that can be used to modify a resource type, follow the instructions below on how to add an endpoint.

If you're adding a new endpoint for a resource

• Find the file in source/includes for the resource you wish to add an endpoint for. If one doesn't exist, take a look at the section above on adding a new resource.
• Endpoints are ordered by CRUD: create, read, update, then delete. If your endpoint doesn't fit one of those categories, use your best judgement to determine where it should fit within the file, and try to observe conventions used in other resource files.
• Add the following to your description of the new endpoint:
  • Examples for cURL and Python.
  • The REST API endpoint backing the endpoint, e.g. PUT /algorithms/:username/:algoname.
  • A description of any and all inputs, such as path and query parameters and the structure a request body should take (if one is required).
  • A description of what will be returned upon success or failure, and an example for the success case.

When in doubt, take a look at how other endpoints have been documented, and leverage existing conventions. If you need to alert a user to sharp edge, or simply point out a nuance, leverage an aside element (check out the examples in the Slate demo).

api-docs's Issues

algo.pipeJson() method doesn't exist.

In the docs it mentions the algo.pipeJson() method, but atm the method doesn't exist.

add Go to codesample tabs

Fix links for algorithm documentation

In the http://docs.algorithmia.com/#algorithm-development section, there are a bunch of links that are supposed to be for algorithm development. But the links are going to client guides (where the focus is calling algorithms outside of algorithmia). I think the dev-center needs a new section on algorithm creation for each language

scala client docs don't use the new scala client

We are done with the scala client so we should stop using the java version in the docs

Clarify AWS lambda "GitHub Repo"

In the http://docs.algorithmia.com/#clients section. The Github link for AWS Lambda says it's the nodejs repo (which technically is correct) but kind of confusing

Create lang docs for Python (and others that are missing)

Currently only Rust, Scala, Java have language api docs which are auto generated R (manually written by James on Cran).

We need the language api docs for the other languages especially Python:
(PyDocs can do this for us for the Python module https://docs.python.org/3/library/pydoc.html).

Algo Not Working with other Pictures

Hi,

I am using this algo "algo://sfw/NudityDetection/1.1.4" to find the Nudity in Pictures. It is working perfectly on the link you have given in sample.

Working on This:
http://www.isitnude.com.s3-website-us-east-1.amazonaws.com/assets/images/sample/young-man-by-the-sea.jpg
https://i.imgur.com/ajilbGq.jpg

But it is not working on my link.
Not Working on This:
https://parsefiles.back4app.com/vkimhy00uIlwZPs0pOiAy50a8yw83iWiWuDTZPu4/227235ff4803c54b1b772e6c237bfc82_IMG_20171212_164856_720.jpg

Update:

It is working on every other link, but not working on the above one only.

Waiting for your reply.

Thanks,
Rashid

Scala auth looks like Rust syntax

import com.algorithmia.*
import com.algorithmia.algo.*

val client = Algorithmia::client("YOUR_API_KEY")

should be:
val client = Algorithmia.client("YOUR_API_KEY")

http://docs.algorithmia.com/?scala#authentication

cli missing code samples

When you visit http://docs.algorithmia.com/?cli there are a few code sections that are blank:
Updating a directory:
Checking if a file exists:

Not sure if we can remove those sections, update the CLI so it can handle these cases, or just document that it's not supported right now

Standardize how we capitalize curl

I think i've seen it as "curl", "cURL" and "CURL" in different spots (and logos)

Missing 'Updating Directories' section in most langs

Only Python and R have code in section 'Updating Directories' section of data api-docs. Also covers updating permissions for directories.

Add for langs:

• Java
• CLI
• Java
• Scala
• JavaScript
• Nodejs
• Ruby
• Rust

Should use 'client.file' not 'robots.file' in Rust sample code

http://docs.algorithmia.com/?rust#files and successive sections read robots.file where it should be client.file for fully-named File access

add C# to codesample tabs

Create API rate limiting info section

I think this new section should go into the API docs, but up for discussion if anyone thinks it should go in developer center.