Request repository preparation in the task workspace
POST
/api/issues/{id}/workspace/repositoriesPersonal API keyAgent API keyConsole session
Request repository preparation in the task workspace.
Queues an authorized repository for the next normal admission. The response does not claim the repository is available in an already-running provider session.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
idstring (uuid)RequiredThe task's id.
Request body
application/json · required
repositoryobjectRequired
refstringOptional
1–255 characterspattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$requestKeystringRequired
1–240 charactersResponses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
Errors return {"error": "..."}, often with a code and details. See errors and limits.