Scalar User Info Hooks API
The user-info-hooks API from Scalar — 2 operation(s) for user-info-hooks.
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/scalar-user-info-hooks-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: Core User Info Hooks API
description: Core services for Scalar
version: 0.1.0
contact:
name: Marc from Scalar
url: https://scalar.com
email: support@scalar.com
servers:
- url: https://api.scalar.com/core
security:
- BearerAuth: []
tags:
- name: user-info-hooks
paths:
/docs/project/{uid}/user-info-hook:
get:
tags:
- user-info-hooks
description: Personalization status for a docs project
operationId: getDocsProjectUidUserInfoHook
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
url:
type: string
hasSecret:
type: boolean
secretUpdatedAt:
anyOf:
- type: number
- type: 'null'
previousSecretExpiresAt:
anyOf:
- type: number
- type: 'null'
required:
- url
- hasSecret
- secretUpdatedAt
- previousSecretExpiresAt
additionalProperties: false
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400'
'401':
description: No auth
content:
application/json:
schema:
$ref: '#/components/schemas/401'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/403'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/404'
'422':
description: Invalid payload
content:
application/json:
schema:
$ref: '#/components/schemas/422'
'500':
description: Uncaught error
content:
application/json:
schema:
$ref: '#/components/schemas/500'
parameters:
- schema:
$ref: '#/components/schemas/nanoid'
in: path
name: uid
required: true
summary: Get docs project uid user info hook
x-summary-source: derived
/docs/project/user-info-hook/rotate-secret:
post:
tags:
- user-info-hooks
description: Generate or roll the user-info hook signing secret for a docs project
operationId: postDocsProjectUserInfoHookRotateSecret
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
secret:
type: string
previousSecretExpiresAt:
anyOf:
- type: number
- type: 'null'
required:
- secret
- previousSecretExpiresAt
additionalProperties: false
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400'
'401':
description: No auth
content:
application/json:
schema:
$ref: '#/components/schemas/401'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/403'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/404'
'422':
description: Invalid payload
content:
application/json:
schema:
$ref: '#/components/schemas/422'
'500':
description: Uncaught error
content:
application/json:
schema:
$ref: '#/components/schemas/500'
requestBody:
content:
application/json:
schema:
type: object
properties:
projectUid:
$ref: '#/components/schemas/nanoid'
revoke:
default: false
type: boolean
required:
- projectUid
- revoke
additionalProperties: false
required: true
summary: Post docs project user info hook rotate secret
x-summary-source: derived
components:
schemas:
nanoid:
type: string
minLength: 5
examples:
- UakgbKJ5m9gl0JDMbcJqL
'404':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: Resource not found.
code: not-found
'403':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: You do not have permission to access this resource.
code: forbidden
'422':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: The request body contains invalid values.
code: invalid-payload
'401':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: Invalid authentication token.
code: unauthorized
'400':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: Invalid request parameters.
code: bad-request
'500':
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
examples:
- message: An unexpected error occurred.
code: unknown
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT