Skip to main content
POST
Create an API endpoint

Authorizations

Authorization
string
header
required

A ManyPI API key (mpi_...) from Settings → API keys, or an OAuth 2.1 access token obtained through the MCP consent flow.

Body

application/json
slug
string
required

Lowercase letters, digits and dashes.

Required string length: 2 - 64
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
name
string
required
Maximum string length: 120
scraper_id
string<uuid>
required
description
string
Maximum string length: 2000
method
enum<string>
default:GET
Available options:
GET,
POST
param_schema
object | null

JSON Schema for the input. Validated on every call.

output_schema
object | null
freshness
enum<string>
default:cached_ok
Available options:
cached_ok,
always_fresh
cache_ttl_seconds
integer
default:3600
Required range: 0 <= x <= 604800
mode
enum<string>
default:sync
Available options:
sync,
async

Response

The created endpoint.

id
string<uuid>
slug
string
name
string
description
string | null
method
enum<string>
Available options:
GET,
POST
scraper_id
string<uuid>
param_schema
object | null
output_schema
object | null
freshness
enum<string>
Available options:
cached_ok,
always_fresh
cache_ttl_seconds
integer
mode
enum<string>
Available options:
sync,
async
created_at
string<date-time>