Getting Started
- Obtain your API key from the Projects Dashboard.
- Create a task by sending a request to /tasks with your prompt and geo settings.
- Track the task using the
session ID
returned. - Fetch results once the task is completed!
Authentication
All endpoints are secured using an API key. You must include your API key in the Authorization header using the following format:Available Endpoints
Method | Endpoint | Description |
---|---|---|
POST | /tasks | Create a new task. |
POST | /tasks/{session_id}/command | Force stop a task. |
GET | /tasks/{session_id} | Get metadata, progress and status of a task. |
GET | /results/{session_id} | Retrieve the results of a task. |
POST | /saved_tasks | Create a saved task. |
GET | /saved_tasks | Get list of saved tasks. |
GET | /saved_tasks/name/{task_name} | Get a saved task by name. |