Validate Api Key

GET 
https://cloud.agenta.ai/api/keys/:key_prefix/validate

This Function is called by the CLI and is used to validate an API key provided by a user in agenta init setup. Returns: bool: True. If the request reaches this point, the API key is valid.

Request

Path Parameters

key_prefix Key Prefixrequired

Responses

200

Successful Response

application/json

Schema

Schema

boolean

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://cloud.agenta.ai/api/keys/:key_prefix/validate' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://cloud.agenta.ai/api

Auth

APIKeyHeader

Parameters

key_prefix — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!