API Reference

Reference for the Get3W REST API.

Base URL

https://api.get3w.com/v1

Authentication

All endpoints require your API key as a Bearer token:

Authorization: Bearer YOUR_API_KEY

See API Authentication for details.

Endpoints

Generation

Method	Endpoint	Description
POST	/v1/{provider_id}/{model_id}/{run_type}	Submit a task
GET	/v1/requests/{request_id}	Get result

The submit path is the model slug. Supported query parameters:

Parameter	Description
sync	Wait for completion and return the result in the same response
webhook	Callback URL to receive the result when the task finishes
prefix	Custom storage prefix for output files

Chat

Chat models use an OpenAI-compatible surface. Point any OpenAI client at https://api.get3w.com/v1 with your Get3W key.

Method	Endpoint	Description
POST	/v1/chat/completions	Chat completion, supports stream
GET	/v1/models	List available chat models

Account

Method	Endpoint	Description
GET	/v1/balance	Check balance

Error Format

Errors from /v1/ endpoints return the HTTP status code plus a JSON body:

{
  "code": 401,
  "error": "Invalid or revoked API key"
}

A task that was accepted but failed during execution returns HTTP 200 with status: "failed" and a task-level code. See Error Codes for both levels.

Next Steps

• Get Started with API
• API Authentication