Skip to content
Ctrl/⌘ K

API reference

Revoke an API key

Permanently revokes one credential owned by the authenticated identity.

DELETE /v1/api-keys/{id}

Parameters

Request parameters
Name
id
In
path
Required
Yes
Type
string
Description
Credential UUID returned at creation.
Request cURL 
curl --request DELETE "https://yep.com/api/v1/api-keys/$YEP_AGENT_SESSION_ID" \
  --header "Authorization: Bearer $YEP_API_KEY"

Responses

Response statuses
Status
204
Description
Key revoked.
Body
object
Status
401
Description
Authentication required.
Body
PublicApiError
Status
403
Description
The API key lacks key-management permission.
Body
PublicApiError
Status
404
Description
Key is absent or owned by another identity.
Body
PublicApiError

Schemas

ErrorCode

Machine-readable product API failure.

Request json 
[
  "unauthenticated",
  "forbidden",
  "invalid_request",
  "not_found",
  "conflict",
  "payment_required",
  "too_many_requests",
  "upstream",
  "internal"
]

ErrorRecovery

Browser-safe recovery action selected by the authoritative product boundary.

ErrorRecovery alternatives
Variant
1
Type
object
Variant
2
Type
object
Variant
3
Type
object

PublicApiError

Stable public error envelope for APIs whose reason vocabulary is extensible.

PublicApiError fields
Field
agent_session_id
Required
No
Type
string | null
Description
Agent execution correlation id, present after an invocation is admitted.
Constraints
Field
code
Required
Yes
Type
ErrorCode
Description
Closed status category suitable for program control flow.
Constraints
Field
message
Required
Yes
Type
string
Description
Safe diagnostic intended for operators, not program branching.
Constraints
Field
reason
Required
Yes
Type
string
Description
Extensible machine-readable detail; clients must accept unknown values.
Constraints
Field
recovery
Required
No
Type
null | ErrorRecovery
Description
Constraints
Field
validation
Required
No
Type
null | ValidationReport
Description
Constraints

ValidationIssue

One actionable, privacy-safe contract violation.

ValidationIssue fields
Field
allowed_values
Required
No
Type
array | null
Description
Constraints
max items: 16
Field
code
Required
Yes
Type
string
Description
Stable, extensible machine-readable category.
Constraints
max length: 64
Field
path
Required
Yes
Type
string
Description
RFC 6901 pointer to the rejected location; empty means the root value.
Constraints
max length: 1024
Field
suggestion
Required
Yes
Type
string
Description
Code-owned instruction for correcting the request.
Constraints
max length: 512

ValidationReport

Bounded validation feedback shared by model, REST, and MCP boundaries.

ValidationReport fields
Field
contract
Required
Yes
Type
string
Description
Stable contract name, normally the published schema component name.
Constraints
max length: 128
Field
issues
Required
Yes
Type
ValidationIssue[]
Description
At most eight deterministic violations. Correct every issue before retrying.
Constraints
max items: 8
Field
truncated
Required
Yes
Type
boolean
Description
Whether more violations were omitted; retry after correcting the listed issues.
Constraints

Commands