API-nøkler

Metoder, forespørselsfelter og svar.

Fullstendig guide

Seksjonen har 5 metoder. Åpne en metode for å se tilgangsvilkår, forespørselsfelter og svar.

Metode og endepunkt	Beskrivelse	Tilgang
`GET /api/v1/keys`	Liste — API-nøkler	Kontrollpaneltoken
`POST /api/v1/keys`	Opprett API-nøkkel	Kontrollpaneltoken
`DELETE /api/v1/keys/:id`	Sletting — API-nøkler	Kontrollpaneltoken
`GET /api/v1/keys/:id`	Hent etter identifikator — API-nøkler	Kontrollpaneltoken
`PUT /api/v1/keys/:id`	Endre API-nøkkel	Kontrollpaneltoken

GET /api/v1/keys — Liste — API-nøkler

Tilgang: kontrollpaneltoken

GET/api/v1/keys

Lesing; ID hentes fra ditt forrige svar

curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
  -H "Authorization: Bearer $TOKEN"

Query-parametere

Feltet	Type	Påkrevd	Validering / beskrivelse
`sort_by`	`string`	nei	; standard: created_at
`sort_order`	`string`	nei	; standard: desc
`search`	`string`	nei
`status`	`string`	nei
`page`	`integer`	nei	; standard: 1; positiv; page_size/limit <=1000
`page_size`	`integer`	nei	; standard: 20; positiv; page_size/limit <=1000
`limit`	`integer`	nei	; standard: 20; positiv; page_size/limit <=1000

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: APIKey. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "user_id": "PLACEHOLDER_USER_ID (integer)",
        "key": "PLACEHOLDER_KEY (string)",
        "name": "PLACEHOLDER_NAME (string)",
        "status": "PLACEHOLDER_STATUS (string)",
        "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
        "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
        "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
        "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)",
        "quota": "PLACEHOLDER_QUOTA (number)",
        "quota_used": "PLACEHOLDER_QUOTA_USED (number)",
        "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
        "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)",
        "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
        "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
        "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
        "usage_5h": "PLACEHOLDER_USAGE_5H (number)",
        "usage_1d": "PLACEHOLDER_USAGE_1D (number)",
        "usage_7d": "PLACEHOLDER_USAGE_7D (number)",
        "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)",
        "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)",
        "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)",
        "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)",
        "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)",
        "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)",
        "user": "PLACEHOLDER_USER (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Svaret inneholder den hemmelige key-verdien; ikke publiser faktiske verdier.

POST /api/v1/keys — Opprett API-nøkkel

Tilgang: kontrollpaneltoken

POST/api/v1/keys

JSON- / skjemafelter

Feltet	Type	Påkrevd	Validering / beskrivelse
`name`	`string`	ja	required
`custom_key`	`string`	nei	; Valgfri egendefinert nøkkelverdi; kan være null
`ip_whitelist`	`array`	nei	; Liste over tillatte IP-er
`ip_blacklist`	`array`	nei	; Liste over blokkerte IP-er
`quota`	`number`	nei	; Nøkkelens forbruksgrense i USD; kan være null
`expires_in_days`	`integer`	nei	; Gyldighetstid i dager; kan være null
`rate_limit_5h`	`number`	nei	; kan være null
`rate_limit_1d`	`number`	nei	; kan være null
`rate_limit_7d`	`number`	nei	; kan være null

Mal for forespørselskropp

{
  "name": "PLACEHOLDER_NAME (string)",
  "custom_key": "PLACEHOLDER_CUSTOM_KEY (string)",
  "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
  "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
  "quota": "PLACEHOLDER_QUOTA (number)",
  "expires_in_days": "PLACEHOLDER_EXPIRES_IN_DAYS (integer)",
  "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
  "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
  "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)"
}

PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.

Forespørselsskjema: CreateAPIKeyRequest

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: APIKey. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "user_id": "PLACEHOLDER_USER_ID (integer)",
    "key": "PLACEHOLDER_KEY (string)",
    "name": "PLACEHOLDER_NAME (string)",
    "status": "PLACEHOLDER_STATUS (string)",
    "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
    "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)",
    "quota": "PLACEHOLDER_QUOTA (number)",
    "quota_used": "PLACEHOLDER_QUOTA_USED (number)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)",
    "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
    "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
    "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
    "usage_5h": "PLACEHOLDER_USAGE_5H (number)",
    "usage_1d": "PLACEHOLDER_USAGE_1D (number)",
    "usage_7d": "PLACEHOLDER_USAGE_7D (number)",
    "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)",
    "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)",
    "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)",
    "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)",
    "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)",
    "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

Merknader: Idempotency-Key støttes; gjentatte kall returnerer det lagrede svaret med X-Idempotency-Replayed.

Merknader: Svaret inneholder den hemmelige key-verdien; ikke publiser faktiske verdier.

DELETE /api/v1/keys/:id — Sletting — API-nøkler

Tilgang: kontrollpaneltoken

DELETE/api/v1/keys/:id

Parametere i URL-stien

Feltet	Type	Påkrevd	Validering / beskrivelse
`id`	`integer`	ja

Forespørselskropp er ikke nødvendig.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Svarskjema, verdiene er illustrative

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

Merknader: Svaret inneholder den hemmelige key-verdien; ikke publiser faktiske verdier.

GET /api/v1/keys/:id — Hent etter identifikator — API-nøkler

Tilgang: kontrollpaneltoken

GET/api/v1/keys/:id

Lesing; ID hentes fra ditt forrige svar

curl --fail-with-body "https://ailoot.ai/api/v1/keys/$ID" \
  -H "Authorization: Bearer $TOKEN"

Parametere i URL-stien

Feltet	Type	Påkrevd	Validering / beskrivelse
`id`	`integer`	ja

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: APIKey. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "user_id": "PLACEHOLDER_USER_ID (integer)",
    "key": "PLACEHOLDER_KEY (string)",
    "name": "PLACEHOLDER_NAME (string)",
    "status": "PLACEHOLDER_STATUS (string)",
    "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
    "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)",
    "quota": "PLACEHOLDER_QUOTA (number)",
    "quota_used": "PLACEHOLDER_QUOTA_USED (number)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)",
    "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
    "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
    "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
    "usage_5h": "PLACEHOLDER_USAGE_5H (number)",
    "usage_1d": "PLACEHOLDER_USAGE_1D (number)",
    "usage_7d": "PLACEHOLDER_USAGE_7D (number)",
    "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)",
    "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)",
    "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)",
    "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)",
    "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)",
    "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Svaret inneholder den hemmelige key-verdien; ikke publiser faktiske verdier.

PUT /api/v1/keys/:id — Endre API-nøkkel

Tilgang: kontrollpaneltoken

PUT/api/v1/keys/:id

Parametere i URL-stien

Feltet	Type	Påkrevd	Validering / beskrivelse
`id`	`integer`	ja

JSON- / skjemafelter

Feltet	Type	Påkrevd	Validering / beskrivelse
`name`	`string`	nei
`status`	`string`	nei	omitempty,oneof=active inactive
`ip_whitelist`	`array`	nei	; Tillatte IP-er: null lar listen være uendret, en tom liste tømmer den; kan være null
`ip_blacklist`	`array`	nei	; Blokkerte IP-er: null lar listen være uendret, en tom liste tømmer den; kan være null
`quota`	`number`	nei	; Nøkkelens forbruksgrense i USD; 0 — ingen grense; kan være null
`expires_at`	`string`	nei	; Utløpstidspunkt i ISO 8601-format; kan være null
`reset_quota`	`boolean`	nei	; Nullstill beløpet som er brukt av forbruksgrensen; kan være null
`rate_limit_5h`	`number`	nei	; kan være null
`rate_limit_1d`	`number`	nei	; kan være null
`rate_limit_7d`	`number`	nei	; kan være null
`reset_rate_limit_usage`	`boolean`	nei	; Nullstill forbruket for tidsvinduene; kan være null

Mal for forespørselskropp

{
  "name": "PLACEHOLDER_NAME (string)",
  "status": "PLACEHOLDER_STATUS (string)",
  "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
  "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
  "quota": "PLACEHOLDER_QUOTA (number)",
  "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
  "reset_quota": "PLACEHOLDER_RESET_QUOTA (boolean)",
  "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
  "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
  "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
  "reset_rate_limit_usage": "PLACEHOLDER_RESET_RATE_LIMIT_USAGE (boolean)"
}

PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.

Forespørselsskjema: UpdateAPIKeyRequest

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: APIKey. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "user_id": "PLACEHOLDER_USER_ID (integer)",
    "key": "PLACEHOLDER_KEY (string)",
    "name": "PLACEHOLDER_NAME (string)",
    "status": "PLACEHOLDER_STATUS (string)",
    "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
    "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)",
    "quota": "PLACEHOLDER_QUOTA (number)",
    "quota_used": "PLACEHOLDER_QUOTA_USED (number)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)",
    "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
    "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
    "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
    "usage_5h": "PLACEHOLDER_USAGE_5H (number)",
    "usage_1d": "PLACEHOLDER_USAGE_1D (number)",
    "usage_7d": "PLACEHOLDER_USAGE_7D (number)",
    "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)",
    "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)",
    "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)",
    "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)",
    "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)",
    "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

Merknader: Svaret inneholder den hemmelige key-verdien; ikke publiser faktiske verdier.

Merknader: Så lenge nøkkelen har uferdige forespørsler med reservasjon, kan forbruksgrensen ikke reduseres eller nullstilles. Send bare feltene du endrer.

Flere spørsmål? Send Request ID og en beskrivelse, så hjelper vi deg.Kontakt brukerstøtte