Skip to main content
POST
/
sessions
cURL
curl --request POST \
  --url https://api.ionq.co/v0.4/sessions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backend": "<string>",
  "settings": {
    "job_count_limit": 123,
    "duration_limit_min": 123,
    "cost_limit": {
      "unit": "<string>",
      "value": 123
    }
  }
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "backend": "<string>",
  "project_id": "<string>",
  "creator_id": "<string>",
  "ended_at": "2023-11-07T05:31:56Z",
  "ender_id": "<string>",
  "active": true,
  "status": "created",
  "started_at": "2023-11-07T05:31:56Z",
  "settings": {
    "job_count_limit": 123,
    "duration_limit_min": 123,
    "cost_limit": {
      "unit": "<string>",
      "value": 123
    },
    "expires_at": "2023-11-07T05:31:56Z"
  }
}
This feature is in beta and only available to select customers today, reach out to [email protected] to request enabling it on your organization.Note: Beta features are subject to change as we gather feedback. Please report any bugs or send feedback to [email protected] or feel free to drop a report in the Community Slack.

Authorizations

​
Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Body

application/json
​
backend
string
required
​
settings
object

Response

201 - application/json

Created

​
id
string
required

The id of the session.

​
created_at
string<date-time>
required
​
organization_id
string
required
​
backend
string | null
required
​
project_id
string | null
required
​
creator_id
string | null
required
​
ended_at
string<date-time> | null
required
​
ender_id
string | null
required
​
active
boolean
required
​
status
enum<string>
required
Available options:
created,
started,
ended
​
started_at
string<date-time> | null
required
​
settings
object