Admiral Launch API
The launch API from Admiral — 15 operation(s) for launch.
The launch API from Admiral — 15 operation(s) for launch.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/meetadmiral-com:meetadmiral-com-launch-api"
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.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Admiral Launch API
version: 0.1.0
tags:
- name: Launch
paths:
/accounts/{account_id}/launch/parse-products:
post:
tags:
- Launch
summary: Parse Products
description: 'Product-CSV connector: any store export (Shopify, Amazon, a plain
sheet) → normalized product list the draft grounds itself in. The
browser reads the file and posts its text — no multipart plumbing.'
operationId: parse_products_accounts__account_id__launch_parse_products_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ParseProductsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/creative/generate-image:
post:
tags:
- Launch
summary: Generate Creative Image
description: 'AI ad-image generation (flag-gated). Generates from a draft''s scanned
brand context when draft_id is given, or standalone from `prompt` alone
(the Studio room) — at least one of the two is required. Feeds the
"Generate ad creative" panel in MetaEditor and the Studio gallery.'
operationId: generate_creative_image_accounts__account_id__launch_creative_generate_image_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateCreativeImageRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/geo-search:
get:
tags:
- Launch
summary: Geo Search
description: Type-ahead for the location editor. Read-only.
operationId: geo_search_accounts__account_id__launch_geo_search_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: q
in: query
required: false
schema:
type: string
default: ''
title: Q
- name: country
in: query
required: false
schema:
type: string
default: ''
title: Country
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/funds:
get:
tags:
- Launch
summary: Funds
description: 'What is actually left in the ad account, before anything is launched.
The numbers already existed — `pipeline/funds_reader.py` reads both
providers for the daily low-balance sweep — but nothing exposed them to
the customer, so the flow could create a campaign, turn it on, and leave
it sitting in an account with no money behind it. The provider says
nothing: it accepts the campaign and simply never serves.
Reported, never judged. `balance_micros` is null for an account with no
prepaid balance to read — a Google account on monthly invoicing has
none, and neither does one whose budget could not be read — and those
two are indistinguishable from here, so this says null and the screen
says it cannot tell rather than inventing a zero.
`tax_rate` is the sales tax the provider adds on top of every figure its
API reports, so the caller can print the number the provider''s own
billing screen prints. India''s 18% GST on ad spend is the case that
matters: ₹3,000 loaded is ₹2,542 of deliverable spend.'
operationId: funds_accounts__account_id__launch_funds_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/languages:
get:
tags:
- Launch
summary: Languages
description: 'Every language a campaign may target. Read-only, fetched live — a
checked-in id table would rot without anyone noticing.'
operationId: languages_accounts__account_id__launch_languages_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/meta-pages:
get:
tags:
- Launch
summary: Meta Pages
description: 'The Facebook Pages this token can run ads for — the ad''s page_id is
the human''s pick, never inferred. pages_show_list is Standard access.'
operationId: meta_pages_accounts__account_id__launch_meta_pages_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/meta-lead-forms:
get:
tags:
- Launch
summary: Meta Lead Forms
description: 'The instant forms a Page already has, for the ad to collect leads in.
Read, never created. A lead form carries a privacy-policy URL and legal
question text that belong to the advertiser; inventing either on their
behalf is not something software should do, and a form with a wrong
privacy URL is the advertiser''s liability rather than Admiral''s.
The reading itself lives in providers/meta/lead_forms.py, because the
push re-checks the same thing and two readers is how a picker and a
launcher come to disagree about which forms are live.'
operationId: meta_lead_forms_accounts__account_id__launch_meta_lead_forms_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: page_id
in: query
required: false
schema:
type: string
default: ''
title: Page Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/meta-geo-search:
get:
tags:
- Launch
summary: Meta Geo Search
description: 'Country type-ahead from Meta''s own geo database — fetched, never a
checked-in table (geo-search precedent). Countries only: the launch
targets whole countries; city-level slicing is an Ads Manager job.'
operationId: meta_geo_search_accounts__account_id__launch_meta_geo_search_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: q
in: query
required: false
schema:
type: string
default: ''
title: Q
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/demand-check:
post:
tags:
- Launch
summary: Demand Check
description: 'Is anyone searching for this? — asked before a rupee moves.
The wizard used to take a website and a budget and say nothing about
whether the business had any search demand at all; you found that out by
spending. This reads the same pages the drafter would read, asks Google''s
own Keyword Planner about them, and answers on screen — including the
unflattering half, which words the site leads with that nobody searches.
Read-only against Google, and it writes no draft: calling it commits the
caller to nothing.'
operationId: demand_check_accounts__account_id__launch_demand_check_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DemandCheckRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts:
post:
tags:
- Launch
summary: Create Draft
operationId: create_draft_accounts__account_id__launch_drafts_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDraftRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Launch
summary: List Drafts
operationId: list_drafts_accounts__account_id__launch_drafts_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts/{draft_id}:
get:
tags:
- Launch
summary: Get Draft
operationId: get_draft_accounts__account_id__launch_drafts__draft_id__get
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Launch
summary: Patch Draft
operationId: patch_draft_accounts__account_id__launch_drafts__draft_id__patch
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchDraftRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts/{draft_id}/validate:
post:
tags:
- Launch
summary: Validate Draft
operationId: validate_draft_accounts__account_id__launch_drafts__draft_id__validate_post
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts/{draft_id}/push:
post:
tags:
- Launch
summary: Push Draft
operationId: push_draft_accounts__account_id__launch_drafts__draft_id__push_post
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts/{draft_id}/upload-video:
post:
tags:
- Launch
summary: Upload Video
description: 'Publish a picked Studio video to YouTube (UNLISTED) and stamp the
returned id onto the draft''s plan.
SCOPE-GATED end to end: flag-gated (video_campaign_enabled_for) so the
endpoint is invisible to accounts the reviewer hasn''t opted in, and the
upload itself needs the youtube.upload scope, which is only granted on
the flag-gated re-consent path. Until Google verifies that scope, a real
call returns Google''s insufficient-permission error verbatim (502) —
that''s the honest state, not a fake success. The campaign builder does
NOT depend on this: a youtube_video_id can also be pasted directly (the
editor''s paste box, and the reviewer''s live smoke).'
operationId: upload_video_accounts__account_id__launch_drafts__draft_id__upload_video_post
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UploadVideoRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/launch/drafts/{draft_id}/discard:
post:
tags:
- Launch
summary: Discard Draft
operationId: discard_draft_accounts__account_id__launch_drafts__draft_id__discard_post
parameters:
- name: draft_id
in: path
required: true
schema:
type: string
format: uuid
title: Draft Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
CreateDraftRequest:
properties:
url:
type: string
title: Url
goal:
anyOf:
- type: string
- type: 'null'
title: Goal
daily_budget_micros:
anyOf:
- type: integer
- type: 'null'
title: Daily Budget Micros
products:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Products
campaign_type:
anyOf:
- type: string
- type: 'null'
title: Campaign Type
type: object
required:
- url
title: CreateDraftRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
PatchDraftRequest:
properties:
plan:
additionalProperties: true
type: object
title: Plan
type: object
required:
- plan
title: PatchDraftRequest
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
DemandCheckRequest:
properties:
url:
type: string
title: Url
daily_budget_micros:
anyOf:
- type: integer
- type: 'null'
title: Daily Budget Micros
geo_ids:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Geo Ids
language_id:
anyOf:
- type: integer
- type: 'null'
title: Language Id
type: object
required:
- url
title: DemandCheckRequest
UploadVideoRequest:
properties:
video_media_id:
type: string
title: Video Media Id
type: object
required:
- video_media_id
title: UploadVideoRequest
ParseProductsRequest:
properties:
csv:
type: string
title: Csv
type: object
required:
- csv
title: ParseProductsRequest
GenerateCreativeImageRequest:
properties:
request_key:
anyOf:
- type: string
- type: 'null'
title: Request Key
draft_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Draft Id
prompt:
anyOf:
- type: string
- type: 'null'
title: Prompt
aspect_ratio:
type: string
title: Aspect Ratio
default: '1:1'
n:
type: integer
title: N
default: 3
reference_media_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Reference Media Ids
image_provider:
anyOf:
- type: string
- type: 'null'
title: Image Provider
image_model:
anyOf:
- type: string
- type: 'null'
title: Image Model
type: object
title: GenerateCreativeImageRequest