Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Algorithm Management APIs
Introduction
algorithms

Algorithm Management APIs

APIs for managing Algorithms on the Algorithmia platform

support@algorithmia.com

algorithms

List and modify Algorithms on Algorithmia

{username}

{algoname}

GETGet Algorithm

https://api.algorithmia.com/v1/algorithms/:username/:algoname
HEADERS
Authorization

<string>

A Simple API key with 'Manage My Algorithms' enabled

PATH VARIABLES
username

<string>

The user's username

algoname

<string>

Algorithm name

Example Request
Get Response
curl
curl --location 'https://api.algorithmia.com/v1/algorithms/<string>/<string>' \
--header 'Authorization;'
200 OK
Example Response
Text
{
  "name": "<string>",
  "details": {
    "summary": "<string>",
    "label": "<string>",
    "tagline": "<string>"
  },
  "settings": {
    "algorithm_callability": "<string>",
    "source_visibility": "<string>",
    "language": "<string>",
    "environment": "<string>",
    "package_set": "<string>",
    "license": "<string>",
    "royalty_microcredits": "<integer>",
    "network_access": "<string>",
    "pipeline_enabled": "<boolean>"
  },
  "version_info": {
    "type": "<string>",
    "semantic_version": "<string>",
    "git_hash": "<string>",
    "release_notes": "<string>",
    "sample_input": "<string>",
    "sample_output": "<string>"
  }
}
Content-Type

application/json

PUTUpdate Algorithm

https://api.algorithmia.com/v1/algorithms/:username/:algoname
HEADERS
Authorization

<string>

A Simple API key with 'Manage My Algorithms' enabled

Content-Type

application/json

PATH VARIABLES
username

<string>

The user's username

algoname

<string>

Algorithm name

Bodyraw 
{
    "details": {
        "summary": "<string>",
        "label": "<string>",
        "tagline": "<string>"
    },
    "settings": {
        "algorithm_callability": "<string>",
        "source_visibility": "<string>",
        "language": "<string>",
        "environment": "<string>",
        "package_set": "<string>",
        "license": "<string>",
        "royalty_microcredits": "<integer>",
        "network_access": "<string>",
        "pipeline_enabled": "<boolean>"
    },
    "version_info": {
        "sample_input": "<string>"
    }
}
Example Request
Error response for all non-200 response
curl
curl --location --request PUT 'https://api.algorithmia.com/v1/algorithms/<string>/<string>' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "details": {
        "summary": "<string>",
        "label": "<string>",
        "tagline": "<string>"
    },
    "settings": {
        "algorithm_callability": "<string>",
        "source_visibility": "<string>",
        "language": "<string>",
        "environment": "<string>",
        "package_set": "<string>",
        "license": "<string>",
        "royalty_microcredits": "<integer>",
        "network_access": "<string>",
        "pipeline_enabled": "<boolean>"
    },
    "version_info": {
        "sample_input": "<string>"
    }
}'
403 Forbidden
Example Response
Text
{
  "error": {
    "code": "<integer>",
    "message": "<string>",
    "id": "<string>"
  }
}
Content-Type

application/json

POSTPublish Algorithm

https://api.algorithmia.com/v1/algorithms/:username/:algoname/versions
HEADERS
Authorization

<string>

A Simple API key with 'Manage My Algorithms' enabled

Content-Type

application/json

PATH VARIABLES
username

<string>

The user's username

algoname

<string>

Algorithm name

Bodyraw 
{
    "details": {
        "summary": "<string>",
        "label": "<string>",
        "tagline": "<string>"
    },
    "settings": {
        "algorithm_callability": "<string>",
        "source_visibility": "<string>",
        "license": "<string>",
        "royalty_microcredits": "<integer>",
        "network_access": "<string>",
        "pipeline_enabled": "<boolean>"
    },
    "version_info": {
        "type": "<string>",
        "semantic_version": "<string>",
        "git_hash": "<string>",
        "release_notes": "<string>",
        "sample_input": "<string>",
        "sample_output": "<string>"
    }
}
Example Request
Error response for all non-200 response
curl
curl --location 'https://api.algorithmia.com/v1/algorithms/<string>/<string>/versions' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "details": {
        "summary": "<string>",
        "label": "<string>",
        "tagline": "<string>"
    },
    "settings": {
        "algorithm_callability": "<string>",
        "source_visibility": "<string>",
        "license": "<string>",
        "royalty_microcredits": "<integer>",
        "network_access": "<string>",
        "pipeline_enabled": "<boolean>"
    },
    "version_info": {
        "type": "<string>",
        "semantic_version": "<string>",
        "git_hash": "<string>",
        "release_notes": "<string>",
        "sample_input": "<string>",
        "sample_output": "<string>"
    }
}'
401 Unauthorized
Example Response
Text
{
  "error": {
    "code": "<integer>",
    "message": "<string>",
    "id": "<string>"
  }
}
Content-Type

application/json