Bygg på Tasked
Ett REST API för projekt, uppgifter, kunder, tillgångar, granskningskommentarer och webhooks. Varje svar innehåller ett anrops-ID och API-versionen; fel delar samma format.
Autentisering
Varje anrop innehåller en API-nyckel för organisationen som en bearer-token: Authorization: Bearer tsk_live_... En nyckel skapas för en specifik organisation med endast de behörigheter som behövs, och kan när som helst återkallas.
Skapa och återkalla nycklar under Organisationsinställningar, på fliken Integrationer, under API-nycklar. API:et ingår i Business-planen.
Öppna organisationsinställningarBehörigheter
En nyckel innehåller en delmängd av dessa behörigheter. Ett anrop till en slutpunkt utanför dessa nekas med statuskod 403.
- projects:read
- projects:write
- tasks:read
- tasks:write
- clients:read
- clients:write
- assets:read
- assets:write
- reviews:read
- webhooks:manage
Slutpunkter
| Metod | Sökväg | Vad den gör | Behörighet |
|---|---|---|---|
| GET | /api/v1/me | The organization and scopes behind this key | projects:read |
| GET | /api/v1/openapi.json | This OpenAPI 3.1 document | Ingen nyckel krävs |
| GET | /api/v1/projects | List projects | projects:read |
| POST | /api/v1/projects | Create a project | projects:write |
| GET | /api/v1/projects/{id} | Get a project | projects:read |
| GET | /api/v1/tasks | List tasks | tasks:read |
| POST | /api/v1/tasks | Create a task | tasks:write |
| GET | /api/v1/tasks/{id} | Get a task | tasks:read |
| PATCH | /api/v1/tasks/{id} | Update a task | tasks:write |
| POST | /api/v1/tasks/{id}/move | Move a task to a stage | tasks:write |
| GET | /api/v1/clients | List clients | clients:read |
| POST | /api/v1/clients | Create a client | clients:write |
| GET | /api/v1/clients/{id} | Get a client | clients:read |
| GET | /api/v1/assets | List assets | assets:read |
| GET | /api/v1/assets/{id} | Get an asset | assets:read |
| POST | /api/v1/assets/uploads | Initiate a direct upload | assets:write |
| POST | /api/v1/assets/uploads/{id}/finalize | Confirm an upload and write the version | assets:write |
| GET | /api/v1/review-comments | List review comments on an asset | reviews:read |
| GET | /api/v1/webhooks | List webhooks | webhooks:manage |
| POST | /api/v1/webhooks | Create a webhook | webhooks:manage |
| GET | /api/v1/webhooks/{id} | Get a webhook | webhooks:manage |
| PATCH | /api/v1/webhooks/{id} | Update a webhook | webhooks:manage |
| DELETE | /api/v1/webhooks/{id} | Delete a webhook | webhooks:manage |
| GET | /api/v1/webhooks/{id}/deliveries | Delivery log of a webhook | webhooks:manage |
| POST | /api/v1/webhooks/{id}/deliveries/{deliveryId}/replay | Replay a delivery | webhooks:manage |
OpenAPI-dokument
Samma rutter, anropskroppar och svar som maskinläsbar OpenAPI 3.1, genererade från de validerare som API:et kör, så att de aldrig kan skilja sig åt.
Ladda ner openapi.jsonFel och gränser
Ett fel svarar med { error, errorCode, requestId, apiVersion }. En nyckel kan skicka 600 anrop per minut; utöver det blir svaret 429. Skicka X-API-Version för att låsa en version; en föråldrad version flaggas i Deprecation-headern.
Kom igång utan kort
Fjorton dagar, allt aktiverat. Öppna en arbetsyta, berätta för AI:n hur du arbetar och bjud in en kund för att godkänna.
Har du en fråga? Skriv till oss
Vi svarar direkt på webbplatsen när vi kan, och en person följer upp om det behövs. Ingen e-postlista.