Welcome to the Captain Data API v3, a powerful tool that allows you to launch workflows, retrieve jobs and results, and manage users and their accounts.
This guide will provide you with a concise overview of how to use any endpoint in the API.
Authentication
To authenticate with the Captain Data API, you need to add the Authorization header with x-api-key along with the x-project-id header to all requests. You can find your project's UID and your API key in your Project's Settings. Remember, never share your credentials!
Example:
curl --location 'https://api.captaindata.co/v3/project' \
--header 'Authorization: x-api-key YOUR_API_KEY' \
--header 'x-project-id: YOUR_PROJECT_UID'
Project Workspace
The Project Workspace endpoint allows you to retrieve basic information about your project, such as the number of tasks used and left. To access this, you would use the GET method on the following endpoint: https://api.captaindata.co/v3/workspace.
Example:
curl --location 'https://api.captaindata.co/v3/workspace' \ --header 'Authorization: x-api-key YOUR_API_KEY' \ --header 'x-project-id: YOUR_PROJECT_UID'
Workflows, Jobs, Results, and More
The Captain Data API v3 also includes endpoints for workflows, jobs, results, inputs, users, integrations, collections, rate limit, webhooks and common errors. Each of these endpoints provides specific functionality for interacting with the Captain Data platform.
For more detailed information about these endpoints, please refer to the official documentation.
Support
If you're having any trouble using this API, don't hesitate to reach out to the Captain Data support team at support@captaindata.co.
Remember, the key to effectively using any API is to read the documentation thoroughly and understand what each endpoint does. Happy coding!
Best practices
⚠️ When using the API, we suggest you try on a small batch of inputs to be able to scale your processes after.
API Playground
We strongly advise using the API playground to generate your body to schedule.
You need to fill in the configuration on the platform and save it.
Then, it will be automatically filled in the API playground for you to copy it.
To understand how the API Playground works, please refer to this article: Launch workflows & get results with the API