Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Ludo Ai Authentication API
version: 0.9.10
x-logo:
url: /static/logo-small.png
altText: Logo
x-refined-note:
- x-model-lineup differs across the merged source definitions and was not carried
description: 'Operations tagged Authentication across 2 of this provider''s published API definitions: ludo-ai-rest-api-openapi.yml, ludo-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
tags:
- name: Authentication
paths:
/auth/validate-api-key:
get:
description: Validates an API key. Returns 200 if valid, 403 if invalid.
tags:
- Authentication
operationId: validateApiKeyEndpoint
security:
- ApiKey: []
responses:
'200':
description: Valid API key
'403':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -X GET \"https://api.ludo.ai/api/auth/validate-api-key\" \\\n -H \"Authorization: ApiKey YOUR_API_KEY\""
- lang: JavaScript
label: JavaScript
source: "const response = await fetch(\"https://api.ludo.ai/api/auth/validate-api-key\", {\n headers: {\n \"Authorization\": \"ApiKey YOUR_API_KEY\"\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n \"https://api.ludo.ai/api/auth/validate-api-key\",\n headers={\"Authorization\": \"ApiKey YOUR_API_KEY\"}\n)\n\nprint(response.json())"
summary: Validate api key endpoint
x-summary-source: derived
servers:
- url: /api
components:
schemas:
ErrorResponse:
type: object
properties:
message:
type: string
metadata:
type: string
error_payload:
type: string
intent:
type: object
description: Stripe intent details sent with 3D Secure (406) errors
properties:
id:
type: string
type:
type: string
enum:
- payment
- setup
example: payment
client_secret:
type: string
securitySchemes:
ApiKey:
type: apiKey
name: Authorization
in: header
description: 'For accessing the API a valid API Key token must be passed in all the queries in
the ''Authorization'' header.
The following syntax must be used in the ''Authorization'' header: ApiKey xxxxxx.yyyyyyy.zzzzzz
'
x-refined-from:
- ludo-ai-rest-api-openapi.yml
- ludo-ai-openapi.json
x-provenance:
method: harvested
publisher: Ludo.ai
source: https://api.ludo.ai/api-documentation/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)