algorithmiaio/api-docs

api-docs's Issues

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.

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

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

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

algo.pipeJson() method doesn't exist.

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

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

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

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).

add C# to codesample tabs

Standardize how we capitalize curl

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

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

add Go to codesample tabs

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