> ## Documentation Index > Fetch the complete documentation index at: https://docs.superx.so/llms.txt > Use this file to discover all available pages before exploring further. # Pause or resume a signal agent > Status-only lifecycle: `active` or `paused`. Paused agents stop finding leads; resuming picks up where the agent left off (a resume is rejected with `invalid_request` when the agent's destination list is gone; point it at a new list in the SuperX app first). Other fields (name, ICP, precision, destination) are edited in the SuperX app. Naturally idempotent, so there is no `Idempotency-Key` support. Main account only in v1. ## OpenAPI ````yaml /api-reference/openapi.yaml patch /v1/signals/agents/{id} openapi: 3.1.0 info: title: SuperX API version: 1.0.0 description: > The SuperX public API: your Twitter/X content, analytics, audience and scheduling data over REST. All endpoints require an API key (`Authorization: Bearer sxk_...`) except `GET /v1/docs`. Keys are created in the SuperX app under Account > API / MCP / CLI and are server-side secrets. Timestamps are UTC ISO-8601 in both directions; inputs must carry an explicit `Z` or numeric offset. Every authenticated response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers. contact: name: SuperX url: https://superx.so servers: - url: https://api.superx.so security: - apiKey: [] tags: - name: Identity - name: Content - name: Analytics - name: Inspiration - name: Audience - name: Contact Lists - name: Signals - name: Media - name: Scheduling - name: Tags - name: Context - name: Queue - name: Articles - name: Meta paths: /v1/signals/agents/{id}: patch: tags: - Signals summary: Pause or resume a signal agent description: | Status-only lifecycle: `active` or `paused`. Paused agents stop finding leads; resuming picks up where the agent left off (a resume is rejected with `invalid_request` when the agent's destination list is gone; point it at a new list in the SuperX app first). Other fields (name, ICP, precision, destination) are edited in the SuperX app. Naturally idempotent, so there is no `Idempotency-Key` support. Main account only in v1. operationId: setSignalAgentStatus parameters: - name: id in: path required: true description: The signal agent's numeric id (from `GET /v1/signals/agents`). schema: type: integer - $ref: '#/components/parameters/AccountId' requestBody: required: true content: application/json: schema: type: object required: - status properties: status: type: string enum: - active - paused example: status: paused responses: '200': description: The updated agent. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/SignalAgent' '400': $ref: '#/components/responses/InvalidParameter' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/WriteForbidden' '404': $ref: '#/components/responses/AgentNotFound' '429': $ref: '#/components/responses/RateLimited' '502': $ref: '#/components/responses/UpstreamError' '503': $ref: '#/components/responses/UpstreamUnavailable' components: parameters: AccountId: name: account_id in: query required: false description: >- Account to act on, from `GET /v1/accounts`. Defaults to your main account. An id outside your accounts returns `404 account_not_found`. schema: type: string headers: X-RateLimit-Limit: description: The limit of the rate window closest to exhaustion. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in that window. schema: type: integer X-RateLimit-Reset: description: Unix timestamp (seconds) when that window resets. schema: type: integer schemas: SignalAgent: type: object properties: id: type: integer name: type: string status: type: string description: active, paused, or error. status_detail: type: string nullable: true icp_description: type: string description: The ideal customer profile the agent scores people against. precision_mode: type: string enum: - high - discovery destination_list_id: type: string nullable: true description: The contact list deposits go to; joins to `GET /v1/contact-lists`. created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true deposited_count: type: integer description: Leads already saved to the destination list. last_checked: type: string format: date-time nullable: true description: The most recent signal run across the agent's signals. signals: type: array items: $ref: '#/components/schemas/SignalAgentSignal' SignalAgentSignal: type: object description: >- One watched signal on an agent. Which fields are set depends on the type (handle/name/avatar for profile and follower watches, query for keyword watches, list_name for list watches). properties: id: type: integer type: type: string enum: - profile_watch - follower_watch - keyword_watch - list_watch handle: type: string nullable: true name: type: string nullable: true avatar: type: string nullable: true query: type: string nullable: true list_name: type: string nullable: true status: type: string status_detail: type: string nullable: true last_run_at: type: string format: date-time nullable: true created_at: type: string format: date-time nullable: true ErrorEnvelope: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Stable machine-readable error code. message: type: string retry_after: type: integer description: Seconds to wait before retrying (rate-limit errors only). LegacyErrorEnvelope: type: object required: - error description: | Legacy shape used ONLY by the shared subscription middleware: a plain string `error` field. Seen on `403` when the subscription has lapsed (string starts with "subscription_required:") and on `500` when subscription verification fails (string starts with "internal_error:"). properties: error: type: string example: >- subscription_required: The SuperX API requires an active subscription responses: InvalidParameter: description: A parameter is missing, malformed, or out of range. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_parameter message: since must be a UTC ISO-8601 timestamp Unauthorized: description: >- Missing/malformed Authorization header (`unauthorized`) or an unknown/revoked key (`invalid_api_key`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_api_key message: Unknown or revoked API key WriteForbidden: description: >- Read-only key (`insufficient_scope`), a linked or shared account (`writes_main_account_only`), or a lapsed subscription (legacy string envelope). content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/LegacyErrorEnvelope' example: error: code: insufficient_scope message: >- This API key is read-only. Create a key with the write scope to use this endpoint. AgentNotFound: description: >- The agent_id is not one of your signal agents (`agent_not_found`), or account_id is not one of your accounts (`account_not_found`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: agent_not_found message: No signal agent with that agent_id belongs to this account. RateLimited: description: Rate limit exceeded (limits vary by plan). Honor Retry-After. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: rate_limited message: >- Rate limit exceeded for the Pro plan (30 requests/min). Upgrade for higher limits. retry_after: 42 UpstreamError: description: A dependent SuperX service returned an unexpected response. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: upstream_error message: Failed to fetch scheduled posts. Try again shortly. UpstreamUnavailable: description: >- The scheduling service is temporarily unreachable. Safe to retry; reuse your Idempotency-Key on POST. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: upstream_unavailable message: >- The scheduling service is temporarily unavailable. Retry with the same Idempotency-Key. securitySchemes: apiKey: type: http scheme: bearer description: >- A SuperX API key ("sxk_..."), created in the SuperX app under Account > API / MCP / CLI. Keys are server-side secrets. ````