Skip to main content

ask-ava-sync 

dci ask-ava-sync

Send a question to Ava and receive a synchronous response. Set ephemeral to true to skip conversation persistence (recommended for programmatic consumers). When ephemeral is false (default), the response includes a conversationId that can be used with the delete endpoint.

Request​

Content-Type: application/json

Schema​

{
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "description": "The question to ask Ava."
    },
    "conversationId": {
      "type": "string",
      "description": "Optional ID of an existing conversation to continue."
    },
    "ephemeral": {
      "type": "boolean",
      "default": false,
      "description": "When true, the conversation is not persisted. Recommended for programmatic consumers (Terraform, MCP, CI pipelines)."
    }
  },
  "required": [
    "question"
  ]
}

Responses​

200 (application/json)​

OK - Ava response returned.

{
  "type": "object",
  "properties": {
    "answer": {
      "type": "string",
      "description": "The Ava response text."
    },
    "conversationId": {
      "type": "string",
      "description": "The conversation ID. Present only for non-ephemeral requests. Can be used with the delete conversation endpoint."
    },
    "answerId": {
      "type": "string",
      "description": "The answer ID within the conversation. Present only for non-ephemeral requests. Required for the feedback endpoint."
    }
  },
  "required": [
    "answer"
  ]
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)​

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: ask-ava-sync, askavasync