Get Started
The Encord API is a REST API that allows you to programmatically query resources such as Projects, Datasets, and labels. The API enables you to use our powerful automation features such as automated labeling, training and inference.
We strongly recommend using our Python Encord SDK to call our API.
API endpoint
The Encord API has the following endpoint
URIs referenced in the documentation are relative to this endpoint.
API authentication
All API requests are authenticated. To authenticate requests with Encord, you simply need to
-
Generate authentication a public / private key pair in our platform.
-
Set authorization headers when making API calls.
1. Set up authentication keys
You can authenticate with Encord on a user basis by registering a public key in the Encord web-app.
2. Set authorization headers
Once you have registered a public key or created an API key, you can authenticate your requests by using your keys in the authorization header of your API calls.
Public key authentication
For user-level operations, set the authorization header to your registered public key followed by a hash of your request data signed by the corresponding private key.
Here is an example of how you can create the correct authorization header using Node
API key authentication
For resource-level operations, set the authorization header of your request to the API key of the resource in question.
Here is an example in Javascript
Examples
Fetch project information
Create a project API key and note both the key and project ID. Here is an example in Node on how to request project information
The response contains the title, description, editor ontology, datasets, and associated label rows, in Python JSON.
Fetch dataset information
Create a dataset API key and note both the key and dataset ID. Here is an example in Node on how to request dataset information
The response contains the title, description, dataset type (e.g. Encord storage vs. AWS S3), and associated data rows, in Python JSON.
Was this page helpful?