Secret names and where they apply. A secret value is never returned.
List an AI team's secrets
GET/v1/teams/{team_id}/secrets
Permissionsecrets.team:read
Names, scope and teams. A value is never returned.
Path parameters
team_idstringrequired
An AI team id.
Query parameters
limitinteger
How many objects to return, 1 to 100. Default 20.
starting_afterstring
Return objects older than this id (the next page).
ending_beforestring
Return objects newer than this id (the previous page).
Headers
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
The value is write-only: no response carries it, and there is no reveal route on the API.
Path parameters
team_idstringrequired
An AI team id.
Headers
Idempotency-Keystring
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Responses
204
Done.
Other
An RFC 9457 problem.
List organization secrets
GET/v1/secrets
Permissionsecrets.org:read
Names, scope and teams. A value is never returned.
Query parameters
limitinteger
How many objects to return, 1 to 100. Default 20.
starting_afterstring
Return objects older than this id (the next page).
ending_beforestring
Return objects newer than this id (the previous page).
Headers
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Org-wide (scope: org) or shared with chosen teams (scope: selected).
The value is write-only: no response carries it, and there is no reveal route on the API.
A key restricted to some AI teams creates only selected secrets, for teams inside its
restriction (an org-wide one is 403 team_restricted, another team 404).
Headers
Idempotency-Keystring
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Responses
204
Done.
Other
An RFC 9457 problem.
Replace an org secret's value
PUT/v1/secrets/{secret_id}/value
Permissionsecrets.org:write
The value is write-only: no response carries it, and there is no reveal route on the API.
Path parameters
secret_idstringrequired
A secret id.
Headers
Idempotency-Keystring
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Responses
204
Done.
Other
An RFC 9457 problem.
Stop sharing a selected secret with a team
DELETE/v1/secrets/{secret_id}/teams/{team_id}
Permissionsecrets.org:assign
Path parameters
secret_idstringrequired
A secret id.
team_idstringrequired
An AI team id.
Headers
Idempotency-Keystring
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.
Responses
204
Done.
Other
An RFC 9457 problem.
Replace an AI team's secret value
PUT/v1/teams/{team_id}/secrets/{secret_id}/value
Permissionsecrets.team:write
The value is write-only: no response carries it, and there is no reveal route on the API.
Path parameters
team_idstringrequired
An AI team id.
secret_idstringrequired
A secret id.
Headers
Idempotency-Keystring
Makes a retry safe: the same key and body within 24 hours returns the first response again
(Idempotent-Replayed: true); the same key with another body is 422.
HQ-Versionstring (date)
A dated API version. Defaults to the version the key was created with.
HQ-Accountstring
Agency keys only: the slug of the client organization this request acts for. Required with
an agency key, refused with 400 invalid_request on any other credential. A slug that is
not one of your agency's current clients is 404 not_found. An agency key is limited to
600 requests a minute per key on EACH API server (the cap is per replica), plus its own
budget per client (limit_scope: agency_client), separate from the client's own keys.