How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Soracom

Soracom Batch API

Batch processing — create batch groups, define jobs that invoke API operations across many SIMs or devices, and inspect tasks for status and results.

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom Batch API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IoT, Batch, and Automation. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

9 operations 5 paths 10 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Batch API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Batch 9

Batch processing

GET
/batch_groups
List batch groups.
listBatchGroups 2 params → 200
POST
/batch_groups
Create batch group.
createBatchGroup body → 200
DELETE
/batch_groups/{batch_group_id}
Delete batch group.
deleteBatchGroup 1 param → 204400404
GET
/batch_groups/{batch_group_id}
Get batch group.
getBatchGroup 1 param → 200404
PUT
/batch_groups/{batch_group_id}
Update batch group.
updateBatchGroup 1 param body → 200404
GET
/batch_groups/{batch_group_id}/jobs
List batch jobs.
listBatchJobs 3 params → 200404
POST
/batch_groups/{batch_group_id}/jobs
Create and run batch job.
createBatchJob 1 param body → 200400404429
GET
/batch_groups/{batch_group_id}/jobs/{job_id}
Get batch job.
getBatchJob 2 params → 200404
GET
/batch_groups/{batch_group_id}/jobs/{job_id}/tasks
List tasks.
listTasksOfBatchJob 5 params → 200404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BatchJobResponse (11 properties), BatchTaskResponse (6 properties), BatchGroupResponse (5 properties), CreateBatchJobRequest (4 properties). Each schema is shown below with its type and property counts.

BatchTaskRequest
object
1 property 1 required
BatchTaskApiRequest
object
The API request of this task.
3 properties 2 required
CreateBatchJobRequest
object
4 properties 1 required
BatchGroupResponse
object
5 properties
BatchTaskApiResponse
object
このタスクの API レスポンス。
2 properties
CreateBatchGroupRequest
object
2 properties 1 required
BatchJobResponse
object
11 properties
BatchTaskResponse
object
6 properties
UpdateBatchGroupRequest
object
2 properties
BatchJobSummary
object
Number of tasks for each status. These numbers are periodically updated during the batch job execution.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-batch-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
AE Profile APIs.io
Soracom Group Configuration API
AE Profile APIs.io
Soracom Billing API
AE Profile APIs.io
Soracom Stats and Diagnostics API
AE Profile APIs.io
Soracom Auth and Access Management API
AE Profile APIs.io
Soracom Lagoon API
AE Profile APIs.io
Soracom Cloud Camera Services API
AE Profile APIs.io
Soracom Analysis API
AE Profile APIs.io
Soracom API Sandbox: Coupon API
AE Profile APIs.io
Soracom API Sandbox: Operator API
AE Profile APIs.io
Soracom API Sandbox: Order API
AE Profile APIs.io
Soracom API Sandbox: Stats API
AE Profile APIs.io
#IoT#Batch#Automation
← Back to S APIs
API Details
ID
soracom:soracom-batch-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Batch
Provider
Soracom
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soracom-batch-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-batch-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Soracom Batch API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.