shipstar-ai

shipstar-ai Banner API

The banner API from shipstar-ai — 2 operation(s) for banner.

GitHub OpenAPI

Operations 2

GET /banner Get Live Banner #
GET /banner/{public_slug} Get Public Banner #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/shipstar-ai/openapi/shipstar-ai-banner-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-upsert-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-mailing-list-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-remove-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-bulk-add-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-page-schema.json
📊
JSONSchema
https://artifacts.apis.io/shipstar-ai/json-schema/shipstar-ai-recipient-upsert-request-schema.json

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/shipstar-ai:shipstar-ai-banner-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shipstar-ai-banner-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shipstar Banner API
  description: 'Public Shipstar REST API (v1). Authenticate with an API token from the dashboard: Authorization: Bearer . For agent access prefer the MCP server at https://mcp.shipstar.ai/mcp (OAuth 2.1, streamable HTTP). Responses carry standard RateLimit-* headers (and Retry-After on 429) so clients can self-throttle. Versioning & deprecation policy: https://docs.shipstar.ai/api-reference/versioning'
  version: 1.0.0
servers:
- url: https://api.shipstar.ai/api/v1
  description: Production
tags:
- name: Banner
paths:
  /banner:
    get:
      tags:
      - Banner
      summary: Get Live Banner
      description: 'Get the announcement banner currently live for a project.

        With an API token, the token''s project; without one, the Shipstar

        house project (what shipstar.ai renders). Exactly one banner is live

        per project — publishing a new one replaces it. 404 when none is

        live (never published, replaced, or past its take-down time).'
      operationId: get_live_banner_banner_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Banner
                properties:
                  slug:
                    type: string
                    description: Stable embed key (`data-shipstar-key`); unchanged when a new banner replaces the old one
                  headline:
                    type: string
                    maxLength: 80
                  body:
                    type: string
                    maxLength: 160
                    description: One sentence on the benefit
                  cta_label:
                    type: string
                    maxLength: 24
                  badge:
                    type: string
                    maxLength: 16
                    description: Short tag shown before the headline ("New" by default); empty string when the banner has no badge
                  link_url:
                    type: string
                    nullable: true
                    description: Where the call-to-action points; null when the banner has no link
                  period_start:
                    type: string
                    format: date
                    nullable: true
                  period_end:
                    type: string
                    format: date
                    nullable: true
                  published_at:
                    type: string
                    format: date-time
                    nullable: true
                  expires_at:
                    type: string
                    format: date-time
                    nullable: true
                    description: When the banner stops being served, if a take-down was set
                  commit_count:
                    type: integer
                    nullable: true
                example:
                  slug: acme-banner
                  headline: Scheduled X threads now post themselves
                  body: Approve once; Shipstar posts the thread at the scheduled time.
                  cta_label: See what's new
                  badge: New
                  link_url: https://acme.com/changelog
                  period_start: '2026-08-31'
                  period_end: '2026-09-07'
                  published_at: '2026-09-07T09:02:11+00:00'
                  expires_at: null
                  commit_count: 14
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
        '404':
          description: No banner is live
      security: []
  /banner/{public_slug}:
    get:
      tags:
      - Banner
      summary: Get Public Banner
      description: 'Get a project''s live announcement banner by its stable public slug.

        The slug is the embed key (`data-shipstar-key`): it stays the same

        when a new banner replaces the old one, so a snippet pasted once keeps

        showing the current banner. 404 when nothing is live for that key.

        This endpoint does not require authentication.'
      operationId: get_public_banner_banner__public_slug__get
      parameters:
      - name: public_slug
        in: path
        required: true
        schema:
          type: string
          title: Public Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Banner
                properties:
                  slug:
                    type: string
                    description: Stable embed key (`data-shipstar-key`); unchanged when a new banner replaces the old one
                  headline:
                    type: string
                    maxLength: 80
                  body:
                    type: string
                    maxLength: 160
                    description: One sentence on the benefit
                  cta_label:
                    type: string
                    maxLength: 24
                  badge:
                    type: string
                    maxLength: 16
                    description: Short tag shown before the headline ("New" by default); empty string when the banner has no badge
                  link_url:
                    type: string
                    nullable: true
                    description: Where the call-to-action points; null when the banner has no link
                  period_start:
                    type: string
                    format: date
                    nullable: true
                  period_end:
                    type: string
                    format: date
                    nullable: true
                  published_at:
                    type: string
                    format: date-time
                    nullable: true
                  expires_at:
                    type: string
                    format: date-time
                    nullable: true
                    description: When the banner stops being served, if a take-down was set
                  commit_count:
                    type: integer
                    nullable: true
                example:
                  slug: acme-banner
                  headline: Scheduled X threads now post themselves
                  body: Approve once; Shipstar posts the thread at the scheduled time.
                  cta_label: See what's new
                  badge: New
                  link_url: https://acme.com/changelog
                  period_start: '2026-08-31'
                  period_end: '2026-09-07'
                  published_at: '2026-09-07T09:02:11+00:00'
                  expires_at: null
                  commit_count: 14
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — wait Retry-After seconds before retrying
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Rate limit exceeded. Please try again later.
        '404':
          description: Banner not found or not live
      security: []
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  headers:
    RateLimitPolicy:
      description: 'Quota policy: <limit>;w=<window seconds>'
      schema:
        type: string
      example: 100;w=60
    RateLimitRemaining:
      description: Requests left in the current window
      schema:
        type: integer
      example: 99
    RetryAfter:
      description: Seconds to wait before retrying (on 429)
      schema:
        type: integer
      example: 60
    RateLimitLimit:
      description: Requests allowed in the current window
      schema:
        type: integer
      example: 100
    RateLimitReset:
      description: Seconds until the window resets
      schema:
        type: integer
      example: 60
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: Enter your API token (created in /dashboard/console).
x-deprecation-policy: https://docs.shipstar.ai/api-reference/versioning
x-sunset-policy: https://docs.shipstar.ai/api-reference/versioning