Skip to content Skip to navigation Skip to topbar

Memory API (v1) - Operations endpoints

(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data. As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Overview

Tag description

Endpoints

/v1/ControlPlane/Operations/{operationId}

Get Operation Status

Get Operation Status

GET/v1/ControlPlane/Operations/{operationId}

Base url: https://memory.twilio.com (base url)

Retrieve the status and result of an asynchronous operation.

Request

Security: Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

operationIdstring

required

The operation ID returned from a write endpoint.

Max length: 512

Responses

200400404429500503

Operation status retrieved successfully.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

operationIdstring

Optional

The unique identifier for this operation.

Max length: 512

statusenum<string>

Optional

The current status of the operation.

Example: COMPLETEDPossible values:

PENDINGRUNNINGCANCELLEDCOMPLETEDFAILED

createdAtstring<date-time>

Optional

When the operation was created.

Example: 2025-11-14T20:29:21Z

statusUrlstring<uri>

Optional

URI to check operation status.

completedAtstring<date-time>

Optional

When the operation completed or failed.

result

oneOf:

Optional

Operation-specific output. Present when status is COMPLETED.

Show result properties

errorobject

Optional

Show error properties

resultUrlstring<uri>

Optional

URL to fetch the resulting resource.

Bad Request

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Not Found

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

This error indicates that you have sent too many requests to the API. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Internal Server Error

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Service Unavailable

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Get Operation Status

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchOperation() {
11  const operation = await client.memory.v1.operations("operationId").fetch();
12
13  console.log(operation.operationId);
14}
15
16fetchOperation();

Response

1{
2  "completedAt": "2009-07-06T20:30:00Z",
3  "createdAt": "2009-07-06T20:30:00Z",
4  "error": {
5    "type": "https://www.example.com",
6    "title": "title",
7    "code": 42,
8    "detail": "detail"
9  },
10  "operationId": "operationId",
11  "result": {},
12  "resultUrl": "https://www.example.com",
13  "status": "COMPLETED",
14  "statusUrl": "https://www.example.com"
15}