Citra Space Mission Effects API
The mission-effects API from Citra Space — 4 operation(s) for mission-effects.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/citra-space:citra-space-mission-effects-api"
All apis
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.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: SOICAT Mission Effects API
version: 0.1.0
tags:
- name: mission-effects
paths:
/mission-effects:
get:
operationId: list_my_mission_effects
parameters:
- description: The satellite whose effects to list
in: query
name: satelliteId
required: false
schema:
format: uuid
type: string
- description: 'The sensor whose standing effects to list: the active ones held to it'
in: query
name: sensorId
required: false
schema:
format: uuid
type: string
- description: 'The mission whose effects to list: the active ones it holds, whoever added them'
in: query
name: missionId
required: false
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/MissionEffectDetail'
type: array
description: ''
summary: The effects the caller holds on a satellite, latest window first; or the active…
tags:
- mission-effects
post:
operationId: create_mission_effect
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectCreate'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectDetail'
description: ''
tags:
- mission-effects
summary: Create mission effect
x-summary-source: derived
/mission-effects/batch:
post:
operationId: create_mission_effects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectBatchCreate'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectBatchResponse'
description: ''
summary: One effect on each satellite named and each member of the groups named, in one…
tags:
- mission-effects
/mission-effects/{id}/cancel:
post:
operationId: cancel_mission_effect
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectDetail'
description: ''
'404':
description: ''
summary: Stops pursuing an Active effect the caller holds, or one an operator added to a…
tags:
- mission-effects
/mission-effects/{id}/priority:
post:
operationId: set_mission_effect_priority
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectPriority'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionEffectDetail'
description: ''
'404':
description: ''
summary: Changes the priority of an Active effect the caller holds
tags:
- mission-effects
components:
schemas:
MissionEffectDetail:
properties:
achievedQuality:
description: keplime's achieved quality, from 0 to 1, once scored
format: double
type:
- number
- 'null'
canCancel:
description: 'Whether you may cancel the effect: it is active, and you hold it, or an operator added it to
a mission you own or whose group you are in'
type: boolean
goal:
$ref: '#/components/schemas/EffectGoal'
id:
format: uuid
type: string
mine:
description: Whether you hold the effect, and so may re-prioritize it
type: boolean
missionId:
description: The mission that holds the effect
format: uuid
type:
- string
- 'null'
priority:
format: int32
type: integer
satelliteId:
format: uuid
type: string
satelliteName:
type:
- string
- 'null'
sensorIds:
description: 'The sensors the effect may use; absent for any sensor its operator can see, or for a
mission''s effect, the mission''s'
items:
format: uuid
type: string
type:
- array
- 'null'
status:
$ref: '#/components/schemas/MissionEffectStatus'
windowStart:
format: date-time
type: string
windowStop:
format: date-time
type:
- string
- 'null'
required:
- id
- satelliteId
- windowStart
- priority
- status
- goal
- mine
- canCancel
type: object
MissionEffectPriority:
properties:
priority:
format: int32
maximum: 10
minimum: 1
type: integer
required:
- priority
type: object
MissionEffectCreate:
properties:
goal:
$ref: '#/components/schemas/EffectGoal'
priority:
format: int32
maximum: 10
minimum: 1
type: integer
satelliteId:
format: uuid
type: string
sensorIds:
description: The sensors the effect may use; absent for any sensor you can see
items:
format: uuid
type: string
type:
- array
- 'null'
windowStart:
format: date-time
type: string
windowStop:
description: When the effect stops being pursued; absent for one held until it is canceled
format: date-time
type:
- string
- 'null'
required:
- satelliteId
- windowStart
- goal
type: object
CharacterizationType:
description: What a Characterization collects (keplime ADR 0079).
enum:
- Stability
- Transmissions
- MSI
- HSI
- OCS
- RCS
type: string
MissionEffectBatchResponse:
properties:
createdCount:
minimum: 0
type: integer
missionEffectIds:
items:
format: uuid
type: string
type: array
required:
- createdCount
- missionEffectIds
type: object
MissionEffectStatus:
description: Whether an effect is still pursued.
enum:
- Active
- Ended
- Canceled
type: string
MissionEffectBatchCreate:
description: 'One effect on each of several satellites: those named and every member of the groups named
now, each its own effect with the same goal, window, priority and sensors. With a mission and
no satellites named, each satellite the mission tasks now.'
properties:
goal:
$ref: '#/components/schemas/EffectGoal'
missionId:
description: 'The mission that holds the effects and pursues them on its sensors: one you own or whose
group you are in'
format: uuid
type:
- string
- 'null'
priority:
format: int32
maximum: 10
minimum: 1
type: integer
satelliteGroupIds:
items:
format: uuid
type: string
type: array
satelliteIds:
items:
format: uuid
type: string
type: array
sensorIds:
description: The sensors the effects may use; absent for any sensor you can see, or the mission's
items:
format: uuid
type: string
type:
- array
- 'null'
windowStart:
format: date-time
type: string
windowStop:
description: When the effects stop being pursued; absent for ones held until they are canceled
format: date-time
type:
- string
- 'null'
required:
- windowStart
- goal
type: object
EffectGoal:
description: 'What an effect is for, with the goal that defines "achieved": keplime''s `SDAMissionEffect`.
Read and written through [`GoalFields`]: Core''s serde_json keeps numbers at arbitrary
precision, which an internally tagged enum cannot deserialize.'
oneOf:
- description: Confirm which cataloged object a track is. Carries no goal.
properties:
effect:
enum:
- Identification
type: string
required:
- effect
type: object
- description: Keep the object's position error bounded, including through a maneuver.
properties:
effect:
enum:
- Custody
type: string
maneuverDeltaVBoundKmS:
description: The along-track velocity change the object could spend between looks, in km/s
format: double
minimum: 0
type: number
maxPositionErrorKm:
description: Re-observe before the propagated position error exceeds this, in km
exclusiveMinimum: 0
format: double
type: number
required:
- maxPositionErrorKm
- maneuverDeltaVBoundKmS
- effect
type: object
- description: 'Characterize the object''s signature: one look per type, on a sensor that collects it.'
properties:
characterizationTypes:
description: 'What to characterize: at least one type, each once'
items:
$ref: '#/components/schemas/CharacterizationType'
minItems: 1
type: array
effect:
enum:
- Characterization
type: string
required:
- characterizationTypes
- effect
type: object
- description: A sustained look, confirmed every hour. Carries no goal.
properties:
effect:
enum:
- ThreatAssessment
type: string
required:
- effect
type: object
- description: 'Assess the outcome of an event: a headcount, a light curve, or both.'
properties:
effect:
enum:
- OutcomeAssessment
type: string
outcomeAssessmentTypes:
description: 'What to look for: at least one type, each once'
items:
$ref: '#/components/schemas/OutcomeAssessmentType'
minItems: 1
type: array
required:
- outcomeAssessmentTypes
- effect
type: object
- description: Separate two closely spaced objects.
properties:
effect:
enum:
- Discrimination
type: string
minimumSeparationKm:
description: The pair's linear separation to resolve, in km
exclusiveMinimum: 0
format: double
type: number
required:
- minimumSeparationKm
- effect
type: object
- description: Look again every six hours to catch a change in the object. Carries no goal.
properties:
effect:
enum:
- ChangeDetection
type: string
required:
- effect
type: object
OutcomeAssessmentType:
description: What an Outcome Assessment looks for after an event (keplime ADR 0080).
enum:
- Headcount
- Stability
type: string
securitySchemes:
HTTPBearer:
scheme: bearer
type: http