Slapshot Autopilot API Collection
Welcome to the Slapshot Autopilot API Collection!
This collection is designed to help you manage jobs in the Slapshot Autopilot system with ease. Use these endpoints to create new jobs and retrieve job details.
Endpoints Included
- Create Job (
POST /api/jobs):
Submit a new job with asset details and processing instructions. - View Jobs (
GET /api/jobs):
Retrieve the status and details of all jobs. - View Job (
GET /api/jobs/{JOB_ID}):
Retrieve the status and details of a specific job using its ID. - Cancel Job (
DELETE /api/jobs/{JOB_ID}):
Cancel all the inferences in a specific job using its ID. - View Inferences (
GET /api/inferences):
Retrieve the status and details of all inferences. - View Inference (
GET /api/inferences/{INFERENCE_ID}):
Retrieve the status and details of a specific inference using its ID. - Cancel Inference (
DELETE /api/inferences/{INFERENCE_ID}):
Cancel a specific inference using its ID.
How to Use
- Set Up Environment Variables:
API_KEY: Your authentication key.
- Create a Job:
- Use the “Create Job” request.
- Provide the required JSON body with asset and service details.
- View all Jobs:
- Use the “View Jobs” request.
- Filter by
service,status,metadataif required.
- View a Job:
- Use the “View Job” request.
- Make sure
JOB_IDis set.
- Cancel a Job:
- Use the “Cancel Job” request.
- Make sure
JOB_IDis set.
- View all Inferences:
- Use the “View Inferences” request.
- Filter by
service,status,metadataif required.
- View an Inference:
- Use the “View Inference” request.
- Make sure
INFERENCE_IDis set.
- Cancel an Inference:
- Use the “Cancel Inference” request.
- Make sure
INFERENCE_IDis set.
Tips
- Check the example request bodies for correct formatting.
- For help, contact the Slapshot support team at support@slapshot.ai