An agent you connected

GET

/api/v1/keys/{id}

curl --request GET \
  --url http://localhost:3000/api/v1/keys/example \
  --header 'Authorization: Bearer <token>'

Where it works, each project with its scope, and every project you could give it. Only your own agents.

Scope: read.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

Key id

Responses

200

The agent

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

projects

required

Where it works, the first where a call without project goes

Array<object>

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

organization

required

string

scope

required

string

Allowed values: read propose write admin

givable

required

Every project you could give it, with the most you may give there

Array<object>

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

organization

required

string

max

required

string

Allowed values: propose read write

Example

{
  "data": {
    "projects": [
      {
        "scope": "read"
      }
    ],
    "givable": [
      {
        "max": "propose"
      }
    ]
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}