AimRank Invite Codes API
The Invite Codes API from AimRank — 5 operation(s) for invite codes.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aimrank-io:aimrank-io-invite-codes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AimRank Invite Codes API
description: Ranking-as-a-Service API — Turn binary comparisons into calibrated rankings with Glicko-2, Bradley-Terry, TrueSkill, and cross-domain transfer learning. Includes webhooks, API keys, RLHF exports, and embeddable widgets.
version: 4.12.0
tags:
- name: Invite Codes
paths:
/api/v1/invite-codes:
post:
tags:
- Invite Codes
summary: Create Invite Code
description: Create a new invite code for sharing.
operationId: create_invite_code_api_v1_invite_codes_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInviteCodeRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Invite Codes
summary: List Invite Codes
description: List invite codes created by the current user.
operationId: list_invite_codes_api_v1_invite_codes_get
parameters:
- name: ranking_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ranking Id
- name: competition_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Competition Id
- name: is_active
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
default: true
title: Is Active
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
title: Page
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 20
title: Page Size
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/invite-codes/validate/{code}:
get:
tags:
- Invite Codes
summary: Validate Invite Code
description: Validate an invite code and check if the user can vote.
operationId: validate_invite_code_api_v1_invite_codes_validate__code__get
parameters:
- name: code
in: path
required: true
schema:
type: string
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/invite-codes/{code}/use:
post:
tags:
- Invite Codes
summary: Use Invite Code
description: Record usage of an invite code (track visitor).
operationId: use_invite_code_api_v1_invite_codes__code__use_post
parameters:
- name: code
in: path
required: true
schema:
type: string
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/invite-codes/{invite_code_id}:
put:
tags:
- Invite Codes
summary: Update Invite Code
description: Update an invite code.
operationId: update_invite_code_api_v1_invite_codes__invite_code_id__put
parameters:
- name: invite_code_id
in: path
required: true
schema:
type: string
title: Invite Code Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInviteCodeRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Invite Codes
summary: Delete Invite Code
description: Deactivate an invite code.
operationId: delete_invite_code_api_v1_invite_codes__invite_code_id__delete
parameters:
- name: invite_code_id
in: path
required: true
schema:
type: string
title: Invite Code Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/invite-codes/{invite_code_id}/analytics:
get:
tags:
- Invite Codes
summary: Get Invite Code Analytics
description: Get analytics for an invite code.
operationId: get_invite_code_analytics_api_v1_invite_codes__invite_code_id__analytics_get
parameters:
- name: invite_code_id
in: path
required: true
schema:
type: string
title: Invite Code Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
UpdateInviteCodeRequest:
properties:
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
max_uses:
anyOf:
- type: integer
- type: 'null'
title: Max Uses
max_votes_per_user:
anyOf:
- type: integer
- type: 'null'
title: Max Votes Per User
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
custom_slug:
anyOf:
- type: string
- type: 'null'
title: Custom Slug
welcome_message:
anyOf:
- type: string
- type: 'null'
title: Welcome Message
type: object
title: UpdateInviteCodeRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CreateInviteCodeRequest:
properties:
scope_type:
type: string
title: Scope Type
ranking_id:
anyOf:
- type: string
- type: 'null'
title: Ranking Id
competition_id:
anyOf:
- type: string
- type: 'null'
title: Competition Id
match_id:
anyOf:
- type: string
- type: 'null'
title: Match Id
access_type:
type: string
title: Access Type
default: vote
requires_registration:
type: boolean
title: Requires Registration
default: false
max_uses:
anyOf:
- type: integer
- type: 'null'
title: Max Uses
max_votes_per_user:
type: integer
title: Max Votes Per User
default: 100
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
custom_slug:
anyOf:
- type: string
- type: 'null'
title: Custom Slug
welcome_message:
anyOf:
- type: string
- type: 'null'
title: Welcome Message
type: object
required:
- scope_type
title: CreateInviteCodeRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key