Skip to content

API Reference

Complete reference for the Get3W REST API.

Base URL

https://api.get3w.com/api/v3

Authentication

All endpoints require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

Task Management

MethodEndpointDescription
POST/api/v3/{model-id}Submit a task
GET/api/v3/predictions/{id}Get result
GET/api/v3/predictions/{id}/resultGet result (alt)
DELETE/api/v3/predictions/{id}Delete task

File Management

MethodEndpointDescription
POST/api/v3/files/uploadUpload files

Models

MethodEndpointDescription
GET/api/v3/modelsList models

Account

MethodEndpointDescription
GET/api/v3/balanceCheck balance
GET/api/v3/usageCheck usage
GET/api/v3/billingsCheck billings

Response Format

All API responses follow this format:

json
{
  "code": 200,
  "message": "success",
  "data": { ... }
}

Error Format

json
{
  "code": 400,
  "message": "Invalid parameters",
  "data": null
}

See Error Codes for a complete list.

Rate Limits

Rate limits depend on your account level. When you exceed your rate limit, the API returns 429 Too Many Requests.

SDKs

Released under the MIT License.