Redeem invite code

POST

/api/v1/beta/codes/redeem

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/beta/codes/redeem \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "code": "example" }'

• Production
• Local development

Redeem an invite code during signup. Public, rate-limited.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

RedeemCodeRequest

Request body for redeeming an invite code.

Attributes: code: The invite code string to redeem.

object

code

required

Code

Invite code to redeem

string

>= 1 characters

Example^generated

{
  "code": "example"
}

Responses

200

Successful Response

Media typeapplication/json

RedeemCodeResponse

Response body after attempting to redeem an invite code.

Attributes: valid: Whether the code was successfully redeemed. credit_limit: Credits provisioned (only present if valid). reason: Why redemption failed (only present if invalid).

object

credit_limit

Any of:

integer

integer

null

null

reason

Any of:

string

string

null

null

valid

required

Valid

boolean

Example^generated

{
  "credit_limit": 1,
  "reason": "example",
  "valid": true
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}