Pocketfm UGC AI Copilot API
38
AI ReadinessNon-Ready (F)38/100
Community OpenAPI document · agent-readyAI/MLLanguage Modelsbearer3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Trigger AI copilot tasks in Ask, Plan, Review, or Research mode, then poll task status in a thread to retrieve generated content. Uses an async request_id-based task model.
Use for: Ask the copilot a question in a thread, Plan a piece of work with the AI copilot, Get the status of a running AI task, List all tasks in a conversation thread
Not supported: Does not handle audio streaming, payments, or user management. Use for AI copilot task generation only.
The UGC AI Copilot API runs AI reasoning tasks in Ask, Plan, Review, and Research modes for user-generated content workflows. It uses an async polling model: a request triggers a task, and the caller polls the task status to retrieve the generated content once it completes. Tasks are tracked through a lifecycle from pending to processing, completed, or failed within a conversation thread.
Install Jentic One Beta
Connect the UGC AI Copilot API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the UGC AI Copilot 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%2Fpocketfm.org%2Fpocketfm" | 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%2Fpocketfm.org%2Fpocketfm" | 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 UGC AI Copilot API.
Trigger AI tasks in Ask, Plan, Review, or Research modes
Poll task status and retrieve the generated content
List the tasks running in a conversation thread
Track a task through its pending, processing, and completed lifecycle
Use Cases
Patterns agents use UGC AI Copilot API for, with concrete tasks.
★ AI Copilot Integration
An AI agent connected to the UGC AI Copilot through Jentic can delegate a reasoning task by triggering an Ask or Research run, then poll the task status until the content is ready. The async model means the agent fires the request and checks back, rather than holding a long synchronous call open.
Trigger a Research task in a thread, then poll task status until it completes and read the content
Async Task Orchestration
Orchestrate long-running AI work by triggering tasks and polling for completion with request-id tracking. The copilot models each task's lifecycle as pending, processing, completed, or failed, so an agent can route on status rather than block.
List the tasks in a thread and poll the status of the one still processing
Content Review Workflow
Run Review-mode tasks to produce structured review output over user-generated content. The copilot returns review results an agent can parse and act on, keeping the review consistent across submissions.
Trigger a Review task on a piece of content and retrieve the structured review output
Key Endpoints
3 endpoints — the ugc ai copilot api runs ai reasoning tasks in ask, plan, review, and research modes for user-generated content workflows.
METHOD
PATH
DESCRIPTION
POST
/api/v1/agent/universal-ai-chat
Trigger an AI task in Ask, Plan, Review, or Research mode
GET
/api/v1/chat/threads/{thread_id}/tasks/list
List tasks in a thread
GET
/api/v1/chat/threads/{thread_id}/tasks/status
Get task status with content
POST
/api/v1/agent/universal-ai-chat
Trigger an AI task in Ask, Plan, Review, or Research mode
GET
/api/v1/chat/threads/{thread_id}/tasks/list
List tasks in a thread
GET
/api/v1/chat/threads/{thread_id}/tasks/status
Get task status with content
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.
U
UGC AI Copilot API
- Non-Ready (F)38/100
93
Foundational Compliance59
Developer Experience & Jentic Compatibility17
AI-Readiness & Agent Experience94
Agent Usability75
Security33
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
93
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).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
59
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C+Signals: 4
2%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
33%
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.
17
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
16%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
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.
75
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
75%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
33
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: FSignals: 1
33%
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 UGC AI Copilot by hand means handling its bearer JWT auth and its async trigger-then-poll task model yourself. Through Jentic you install once, import it from the API Directory, store the token once, and your agent calls it.
Permission scoping
The copilot carries its mode and prompt in the request body, so a rule bounds which operations your agent may call rather than which thread. A rule can allow triggering tasks and reading status while keeping the surface to exactly those operations.
Credential isolation
Your UGC AI Copilot token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'ask the copilot a question', and Jentic returns the matching UGC AI Copilot 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 UGC AI Copilot API through Jentic.
Is there a PocketFM AI Copilot MCP server?
You don't need an MCP server to give your agent the UGC AI Copilot API. Jentic connects it directly from the API Directory: import it, store your token once, and your agent can trigger tasks and poll their status. Operations are discovered on demand, so your agent's context stays lean.
Can I limit what my agent is allowed to do with the UGC AI Copilot API?
Yes. The copilot carries its mode and prompt in the request body, so a rule bounds which operations your agent may call. Write a rule that allows triggering tasks and reading status and nothing more, and every call Jentic makes is logged.
What authentication does the UGC AI Copilot API use?
The UGC AI Copilot API authenticates with a bearer token in the Authorization header, formatted as a JWT per its OpenAPI spec. With Jentic, the token is stored encrypted by your own Jentic One instance and injected at call time, so it never reaches the agent.
How does the async task model work in the UGC AI Copilot API?
A request triggers a task and returns a request id, then your agent polls the task status endpoint in the thread until the task moves from pending or processing to completed. The status response carries the generated content once the task is done.
What are the rate limits for the UGC AI Copilot API?
The OpenAPI spec does not specify rate limits. Check the PocketFM documentation at https://pocketfm.org for current limits before triggering tasks at high volume.
How do I trigger an AI task with the UGC AI Copilot API through Jentic?
Import the UGC AI Copilot API from the Jentic API Directory, store your token once, and have your agent search by intent such as 'ask the copilot a question'. Jentic returns the trigger operation with its input schema, and your agent passes the mode and prompt. To run it on your own infrastructure, install Jentic One from its GitHub repo.
GET STARTED