fanvault-shop Social API
The Social API from fanvault-shop — 3 operation(s) for social.
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/fanvault-shop:fanvault-shop-social-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Fanvault Social API
version: 1.0.0
description: Programmatic control of a Fanvault creator storefront. Every path below is one tool from the shared registry, reachable over plain HTTP; the same registry is served as MCP over Streamable HTTP at the endpoint in the x-mcp block, and drives the `fanvault` CLI. All money values are integer cents.
servers:
- url: https://fanvault.shop
security:
- bearerAuth: []
tags:
- name: Social
paths:
/api/v1/tools/generate_story_image:
post:
operationId: generate_story_image
summary: Generate story image
description: 'Renders a branded 1080×1920 promo image (for an Instagram story) from a listing or an existing IG post, and stores it — returning a storage path you then pass to publish_to_instagram. Provide exactly one source: listing_id, or instagram_media_id / instagram_post_url. (Some structured payloads call the listing id auction_id — they are the same id.)'
tags:
- Social
security:
- bearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 255
description: Replays the stored response for a repeat of the same call within 24h. Strongly recommended on every mutating call — agents retry on ambiguous network failures, and without a key a retry creates a second listing, post, or message.
- name: X-Fanvault-Dry-Run
in: header
required: false
schema:
type: string
enum:
- '1'
description: Run every precondition and return the change that would be made, writing nothing.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
creator:
type: string
maxLength: 64
description: 'Which creator to act on: a creator UUID or @handle. Required for admin/agency tokens that manage multiple creators and for tokens restricted to more than one creator (see list_managed_creators); omit it when the token is pinned to exactly one creator or you are the creator.'
listing_id:
type: integer
minimum: 1
description: Listing to feature.
instagram_media_id:
type: string
description: Existing IG media id to remix.
instagram_post_url:
type: string
format: uri
description: Existing IG post URL to remix.
headline:
type: string
maxLength: 80
description: Optional headline overlay.
additionalProperties: false
responses:
'200':
description: Tool result.
content:
application/json:
schema:
type: object
properties:
content:
type: array
items:
type: object
properties:
type:
type: string
text:
type: string
required:
- type
- text
structuredContent:
type: object
properties:
creator:
type: object
properties:
id:
type: string
handle:
type:
- string
- 'null'
required:
- id
- handle
additionalProperties: true
additionalProperties: true
required:
- content
'400':
description: Invalid params, or the acting creator is ambiguous.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or invalid bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Token lacks the required scope, or targets a creator it may not act on.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unknown tool, or the referenced resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: A precondition is unmet (payouts not connected, ship-from unset, ...).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: The action was understood but could not be completed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limited. Honor Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v1/tools/get_social_insights:
post:
operationId: get_social_insights
summary: Get social insights
description: 'Returns Instagram or TikTok account + top-media insights for the creator. PREREQUISITE: the platform must be connected (check get_profile). Connecting Instagram/TikTok is browser-only (Fanvault app → Settings) — there is no MCP tool for it, so on a not-connected error ask the creator to connect there. Reaches the platform''s API.'
tags:
- Social
security:
- bearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 255
description: Replays the stored response for a repeat of the same call within 24h. Strongly recommended on every mutating call — agents retry on ambiguous network failures, and without a key a retry creates a second listing, post, or message.
- name: X-Fanvault-Dry-Run
in: header
required: false
schema:
type: string
enum:
- '1'
description: Run every precondition and return the change that would be made, writing nothing.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
creator:
type: string
maxLength: 64
description: 'Which creator to act on: a creator UUID or @handle. Required for admin/agency tokens that manage multiple creators and for tokens restricted to more than one creator (see list_managed_creators); omit it when the token is pinned to exactly one creator or you are the creator.'
platform:
type: string
enum:
- instagram
- tiktok
description: Which connected platform to read.
required:
- platform
additionalProperties: false
responses:
'200':
description: Tool result.
content:
application/json:
schema:
type: object
properties:
content:
type: array
items:
type: object
properties:
type:
type: string
text:
type: string
required:
- type
- text
structuredContent:
type: object
properties:
creator:
type: object
properties:
id:
type: string
handle:
type:
- string
- 'null'
required:
- id
- handle
additionalProperties: true
additionalProperties: true
required:
- content
'400':
description: Invalid params, or the acting creator is ambiguous.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or invalid bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Token lacks the required scope, or targets a creator it may not act on.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unknown tool, or the referenced resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: A precondition is unmet (payouts not connected, ship-from unset, ...).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: The action was understood but could not be completed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limited. Honor Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v1/tools/publish_to_instagram:
post:
operationId: publish_to_instagram
summary: Publish to Instagram
description: 'Publishes an image to the creator''s Instagram as a story or feed post. PREREQUISITE: Instagram connected with publishing permissions (connecting is browser-only in the Fanvault app — no MCP tool for it). image_path is a storage path from generate_story_image (or an uploaded image). A feed post should include a caption. To publish later, use schedule_action with kind publish_instagram_story/feed.'
tags:
- Social
security:
- bearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
maxLength: 255
description: Replays the stored response for a repeat of the same call within 24h. Strongly recommended on every mutating call — agents retry on ambiguous network failures, and without a key a retry creates a second listing, post, or message.
- name: X-Fanvault-Dry-Run
in: header
required: false
schema:
type: string
enum:
- '1'
description: Run every precondition and return the change that would be made, writing nothing.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
creator:
type: string
maxLength: 64
description: 'Which creator to act on: a creator UUID or @handle. Required for admin/agency tokens that manage multiple creators and for tokens restricted to more than one creator (see list_managed_creators); omit it when the token is pinned to exactly one creator or you are the creator.'
target:
type: string
enum:
- story
- feed
description: Where to publish.
image_path:
type: string
description: Storage path (from generate_story_image) of the image to publish.
listing_id:
type: integer
minimum: 1
description: Listing to reference in an auto-caption.
caption:
type: string
maxLength: 2200
description: Caption (recommended for feed posts).
required:
- target
- image_path
additionalProperties: false
responses:
'200':
description: Tool result.
content:
application/json:
schema:
type: object
properties:
content:
type: array
items:
type: object
properties:
type:
type: string
text:
type: string
required:
- type
- text
structuredContent:
type: object
properties:
creator:
type: object
properties:
id:
type: string
handle:
type:
- string
- 'null'
required:
- id
- handle
additionalProperties: true
additionalProperties: true
required:
- content
'400':
description: Invalid params, or the acting creator is ambiguous.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or invalid bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Token lacks the required scope, or targets a creator it may not act on.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unknown tool, or the referenced resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: A precondition is unmet (payouts not connected, ship-from unset, ...).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: The action was understood but could not be completed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limited. Honor Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
hint:
type: string
retryAfterSeconds:
type: integer
details: {}
required:
- code
- message
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'A Fanvault personal access token (fv_mcp_…), created at /settings/cli or /settings/mcp, or an OAuth 2.1 access token. Sent as `Authorization: Bearer <token>`.'
x-mcp:
endpoint: https://fanvault.shop/mcp
transport: streamable-http
spec_revision: '2025-11-25'
auth: Bearer PAT (fv_mcp_…) or OAuth 2.1
scopes:
- read
- write
- destructive
- payments
tool_count: 82
x-fanvault:
manifest: https://fanvault.shop/api/v1/manifest
manifest_version: 1
tools_hash: 385678b0326a5acd4c4ad0e412991ec0c9a510ea57eb743899b7c40ad0a5ecf4
min_cli_version: 0.1.0
cli:
install: npm i -g fanvault
docs: https://fanvault.shop/developers/cli