Definition Studio
Available from Phase 3
/api/v1/studio/sessionsAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Query Parameters
uuiduuid1 <= length1 <= value <= 200501 <= lengthResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/studio/sessions"{ "data": [ null ], "nextCursor": "string"}/api/v1/studio/sessionsAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Header Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'null/api/v1/studio/sessions/{id}An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08"null/api/v1/studio/sessions/{id}/examplesAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/examples" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'null/api/v1/studio/sessions/{id}/draft-definitionAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft-definition" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'null/api/v1/studio/sessions/{id}/decomposeAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/decompose" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'null/api/v1/studio/sessions/{id}/calibrateAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/calibrate" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'{ "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39", "evalRunId": "48c66916-3a2f-4912-aef2-bb48b65d9a07"}/api/v1/studio/sessions/{id}/request-labelsAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/request-labels" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'null/api/v1/studio/sessions/{id}/promoteAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthThe draft ETag (its spec_hash).
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/studio/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/promote" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'nullBandwise is an independent product built on TypeSafe's System One models. It is not TypeSafe's documentation. For the System One models themselves, see docs.typesafe.ai.