Official vendor OpenAPI document · agent-readyDeveloper ToolsTesting QaapiKey7 EndpointsREST
For Agents
Upload, update, list, and group iOS and Android apps for Appetize.io's browser-based mobile streaming, and pull usage summaries.
Use for: Upload a new Android APK to Appetize for embedded streaming, Update an existing Appetize app with a new build, List all apps registered in the Appetize account, Get the public key for a deployed Appetize app
Not supported: Does not handle real-device test grids, automated test orchestration, or app store distribution - use for Appetize browser-based mobile streaming only.
The Appetize API drives Appetize.io's browser-based mobile app streaming service, letting teams upload .ipa and .apk binaries, update existing apps, list registered apps, group apps into tenants, and pull usage analytics. Customers embed the resulting app session into product demos, support tooling, automated tests, and developer documentation without distributing the binary or asking users to install anything. Authentication is via the X-API-KEY header. Useful for QA platforms, sales engineering teams, and developer-relations workflows that need an interactive mobile app inside a web page.
Install Jentic One Beta
Connect the Appetize API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Appetize API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapi.appetize.io%2Fappetize" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapi.appetize.io%2Fappetize" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Appetize API.
Upload a new iOS or Android app binary to Appetize via POST /apps
List apps available in the account through GET /apps and GET /apps/all
Retrieve a single app's metadata and configuration via GET /apps/{publicKey}
Update an existing app's binary or settings via PUT /apps/{publicKey}
Delete an app from the workspace via DELETE /apps/{publicKey}
Pull aggregated usage metrics across the account via /usageSummary
Use Cases
Patterns agents use Appetize API for, with concrete tasks.
★ Embed a live mobile demo in a marketing site
Upload an .ipa or .apk via POST /apps, capture the publicKey from the response, and use it to render an Appetize embed in a marketing or product page. Visitors can interact with the real app inside the browser without an install. PUT /apps/{publicKey} swaps in newer builds without changing the embed URL, so a marketing or DevRel team keeps the demo evergreen.
POST /apps with the .ipa file and platform=ios, capture the returned publicKey, then construct the Appetize embed URL for the marketing page.
Automated mobile QA pipeline
Wire Appetize into a CI pipeline so every successful mobile build is uploaded via POST /apps and made available to QA inside a browser. Test agents, manual QA, and product reviewers can all share the same Appetize session URL, with PUT /apps/{publicKey} updating the same key per branch. Cuts down on the friction of distributing internal builds via TestFlight or Firebase App Distribution.
On a successful CI build, PUT /apps/{publicKey} with the new APK so the QA-shared Appetize URL serves the latest version.
Usage and cost tracking
Pull aggregated usage data via /usageSummary into an internal billing dashboard or FinOps tool to see how much Appetize streaming time each app consumed in the period. Helps engineering leaders attribute Appetize spend to specific products or environments, and triggers cleanup of /apps that are no longer being used.
Call /usageSummary for the current month and surface total minutes streamed grouped by app to a FinOps dashboard.
Agent integration via Jentic
Give a DevRel or QA agent a small set of CRUD-style tools (upload, update, list, delete, usage summary) over Appetize through Jentic. The agent receives the operation schemas without needing to read the Appetize docs and the X-API-KEY stays in your Jentic One instance. Suitable for assistants that automate demo-build refresh or QA build distribution.
Search Jentic for 'upload mobile build to Appetize', load POST /apps, and execute it with the binary and platform from a CI artefact.
Key Endpoints
7 endpoints — the appetize api drives appetize.
METHOD
PATH
DESCRIPTION
POST
/apps
Upload a new iOS or Android app binary
GET
/apps
List apps visible to the calling key
GET
/apps/all
List every app across the account
GET
/apps/{publicKey}
Retrieve a single app by public key
PUT
/apps/{publicKey}
Update an existing app binary or settings
DELETE
/apps/{publicKey}
Delete an app from the workspace
GET
/usageSummary
Aggregated streaming usage statistics
POST
/apps
Upload a new iOS or Android app binary
GET
/apps
List apps visible to the calling key
GET
/apps/all
List every app across the account
GET
/apps/{publicKey}
Retrieve a single app by public key
PUT
/apps/{publicKey}
Update an existing app binary or settings
DELETE
/apps/{publicKey}
Delete an app from the workspace
GET
/usageSummary
Aggregated streaming usage statistics
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Appetize API
- AI-Aware (B+)69/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility54
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
54
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
52%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
64%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Appetize API by hand means handling its X-API-KEY header, targeting the v1 host, and mapping the app upload, update, and usage routes yourself. Through Jentic you install once, import Appetize from the API Directory, store the key once, and your agent calls it.
Permission scoping
Appetize puts the app public key in the URL path (/apps/{publicKey}), so a rule can pin your agent to one app: it can read and update that app and nothing else. You choose the operations it may call, so app deletion is not included unless you add it.
Credential isolation
Your Appetize X-API-KEY is stored once, encrypted, by your own Jentic One instance and injected as the header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'upload a mobile build', and Jentic returns the matching Appetize operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Appetize API through Jentic.
What authentication does the Appetize API use?
The Appetize API uses an API key in the X-API-KEY header. Keys are generated from the Appetize dashboard and scoped per account. Through Jentic the key is stored in your Jentic One instance and injected at execution time, so agents never see the raw secret in their context.
Can I upload a new mobile binary through the Appetize API?
Yes. POST /apps accepts an .ipa or .apk along with platform metadata and returns a publicKey that identifies the streaming session. To replace the binary on an existing key without breaking the embed URL, use PUT /apps/{publicKey} with the new file.
How do I list every app in my Appetize account?
GET /apps returns the apps visible to the calling key, while GET /apps/all returns the full account-wide list (including those across other groups). Use these to drive an internal dashboard or to clean up apps no longer in use via DELETE /apps/{publicKey}.
What are the rate limits for the Appetize API?
Appetize does not advertise hard rate limits in the spec; in practice account-level limits are generous for read endpoints and tighter for upload endpoints. Agents that bulk-upload many builds should serialise uploads and respect 429 responses.
How do I upload a build to Appetize through Jentic?
Search Jentic for 'upload mobile build to Appetize', load the POST /apps operation, and execute it with the binary file and platform. Capture the publicKey from the response and store it alongside the build artefact for later embedding.
Is the Appetize API free to use?
Appetize offers a free tier with limited streaming minutes and paid plans for production usage. The API itself is the same across tiers; the streaming minutes are billed against the plan. Track consumption via /usageSummary to avoid surprise overages.
Can I limit what my agent is allowed to do with the Appetize API?
Yes. Because your Jentic One instance is self-hosted, your own rules decide which Appetize operations the agent may call and which credentials it may use. Since Appetize puts the app public key in the URL path (/apps/{publicKey}), you can pin the agent to a single app and let it only read and update that one via GET and PUT /apps/{publicKey}. You choose the operations it can reach, so destructive calls like DELETE /apps/{publicKey} stay off unless you explicitly add them.
GET STARTED