> For the complete documentation index, see [llms.txt](https://docs.sprinto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinto.com/api-references/custom-integration-push-apis/session-management.md).

# Session Management

Session lifecycle management

## Start a new session

> Public endpoint. Requires integration API key in \`api-key\` header.

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"tags":[{"name":"Session Management","description":"Session lifecycle management"}],"servers":[{"url":"https://api.sprinto.com/api/external/push","description":"Sprinto US region API server"},{"url":"https://in.sprinto.com/api/external/push","description":"Sprinto IN region API server"},{"url":"https://eu.sprinto.com/api/external/push","description":"Sprinto EU region API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-key"}},"parameters":{"version":{"name":"version","in":"path","required":true,"schema":{"type":"string","enum":["v1"],"default":"v1"},"description":"API version (e.g., v1)"},"integration_id":{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"Sprinto-issued integration identifier."}},"schemas":{"CreateSessionRequest":{"type":"object","properties":{"client_reference_id":{"type":"string","description":"Caller-side correlation id"}},"additionalProperties":false},"Session":{"type":"object","properties":{"id":{"type":"string"},"integration_id":{"type":"string"},"state":{"type":"string","enum":["active","processing","processed","failed","discard","expired"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"inactivity_timeout_seconds":{"type":"integer"},"accepted_records_total":{"type":"integer","default":0},"accepted_records_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"last_error":{"type":"string","nullable":true}},"required":["id","integration_id","state","created_at","expires_at"]}}},"paths":{"/{version}/integrations/{integration_id}/sessions":{"post":{"tags":["Session Management"],"summary":"Start a new session","description":"Public endpoint. Requires integration API key in `api-key` header.","parameters":[{"$ref":"#/components/parameters/version"},{"$ref":"#/components/parameters/integration_id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionRequest"}}}},"responses":{"201":{"description":"Session created","headers":{"X-Session-Id":{"description":"Echo of the created session id","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"401":{"description":"Unauthorized"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds until limit resets."}}}}}}}}
```

## Get session status

> Returns state and counts of accepted rows so far (by entity and total).

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"tags":[{"name":"Session Management","description":"Session lifecycle management"}],"servers":[{"url":"https://api.sprinto.com/api/external/push","description":"Sprinto US region API server"},{"url":"https://in.sprinto.com/api/external/push","description":"Sprinto IN region API server"},{"url":"https://eu.sprinto.com/api/external/push","description":"Sprinto EU region API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-key"}},"parameters":{"version":{"name":"version","in":"path","required":true,"schema":{"type":"string","enum":["v1"],"default":"v1"},"description":"API version (e.g., v1)"},"integration_id":{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"Sprinto-issued integration identifier."},"session_id":{"name":"session_id","in":"path","required":true,"schema":{"type":"string"},"description":"Session identifier returned by the session creation endpoint."}},"schemas":{"SessionStatus":{"allOf":[{"$ref":"#/components/schemas/Session"},{"type":"object","properties":{"accepted_batches":{"type":"integer","default":0},"retry_count":{"type":"integer","default":0}}}]},"Session":{"type":"object","properties":{"id":{"type":"string"},"integration_id":{"type":"string"},"state":{"type":"string","enum":["active","processing","processed","failed","discard","expired"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"inactivity_timeout_seconds":{"type":"integer"},"accepted_records_total":{"type":"integer","default":0},"accepted_records_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"last_error":{"type":"string","nullable":true}},"required":["id","integration_id","state","created_at","expires_at"]}}},"paths":{"/{version}/integrations/{integration_id}/sessions/{session_id}":{"get":{"tags":["Session Management"],"summary":"Get session status","description":"Returns state and counts of accepted rows so far (by entity and total).","parameters":[{"$ref":"#/components/parameters/version"},{"$ref":"#/components/parameters/integration_id"},{"$ref":"#/components/parameters/session_id"}],"responses":{"200":{"description":"Session status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStatus"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Session not found"}}}}}}
```

## Close the session & start processing

> Send \`apply\` to apply staged data or \`discard\` to discard. Processing retries once on Sprinto side.

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"tags":[{"name":"Session Management","description":"Session lifecycle management"}],"servers":[{"url":"https://api.sprinto.com/api/external/push","description":"Sprinto US region API server"},{"url":"https://in.sprinto.com/api/external/push","description":"Sprinto IN region API server"},{"url":"https://eu.sprinto.com/api/external/push","description":"Sprinto EU region API server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-key"}},"parameters":{"version":{"name":"version","in":"path","required":true,"schema":{"type":"string","enum":["v1"],"default":"v1"},"description":"API version (e.g., v1)"},"integration_id":{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"Sprinto-issued integration identifier."},"session_id":{"name":"session_id","in":"path","required":true,"schema":{"type":"string"},"description":"Session identifier returned by the session creation endpoint."}},"schemas":{"CloseSessionRequest":{"type":"object","properties":{"status":{"type":"string","enum":["apply","discard"],"default":"apply"}},"required":["status"]},"SessionStatus":{"allOf":[{"$ref":"#/components/schemas/Session"},{"type":"object","properties":{"accepted_batches":{"type":"integer","default":0},"retry_count":{"type":"integer","default":0}}}]},"Session":{"type":"object","properties":{"id":{"type":"string"},"integration_id":{"type":"string"},"state":{"type":"string","enum":["active","processing","processed","failed","discard","expired"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"inactivity_timeout_seconds":{"type":"integer"},"accepted_records_total":{"type":"integer","default":0},"accepted_records_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"last_error":{"type":"string","nullable":true}},"required":["id","integration_id","state","created_at","expires_at"]}}},"paths":{"/{version}/integrations/{integration_id}/sessions/{session_id}/close":{"post":{"tags":["Session Management"],"summary":"Close the session & start processing","description":"Send `apply` to apply staged data or `discard` to discard. Processing retries once on Sprinto side.","parameters":[{"$ref":"#/components/parameters/version"},{"$ref":"#/components/parameters/integration_id"},{"$ref":"#/components/parameters/session_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseSessionRequest"}}}},"responses":{"202":{"description":"Transition accepted; processing started (async)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStatus"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Session not found"},"409":{"description":"Session not in a closable state"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sprinto.com/api-references/custom-integration-push-apis/session-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.