COcomposal
agent

Exchange a delegated runner capability for home-repository and user API credentials

Requires the server-held turn capability delegated by Roder. Browser session capabilities, browser cookies, and personal access tokens are not accepted. Returns a short-lived repository credential for the org Home checkout and a short-lived system personal access token that authenticates API/CLI calls as the spawning user. Both expire together and are reissued on refresh.

post/api/v1/agent/roder/workspace_credentials

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/agent/roder/workspace_credentials
  • Auth
    HTTP bearer

Request body

required_lifetime_secondsinteger required

Lifetime the pending clone or command must be able to complete within.

Response

Short-lived repository clone and user API credentials

clone_urlstring uri required
username'vex' required
repository_specstring required

The explicitly selected physical repository address.

default_branchstring required
author_namestring required
author_emailstring email required
tokenstring password required

Short-lived read/write repository credential. The raw value is returned once and only its digest is stored.

api_tokenstring password required

Short-lived personal access token for the spawning user. Installed into the sandbox CLI config so vex and API clients act as that user. The raw value is returned once and only its digest is stored.

expires_atstring date-time required
organization_idstring required
repository_idstring required
repository_slugstring required

Changes

No recorded changes to this operation across all 3 revisions of this API.