{
  "connectors" : [ {
    "api_type" : "REST",
    "name" : "Meta",
    "description" : "description",
    "auth_action" : {
      "auth_type" : "API_KEY",
      "auth" : {
        "custom_keys" : {
          "keys" : [ null, null ]
        },
        "api_auth" : {
          "prefix" : "prefix",
          "keyName" : "Authorization",
          "location" : "header"
        }
      }
    },
    "version" : "version",
    "actions" : [ {
      "request" : {
        "raw" : {
          "variables" : [ {
            "path" : "$.messages[0].content"
          }, {
            "path" : "$.messages[0].content"
          } ],
          "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
        },
        "type" : "RAW"
      },
      "method" : "POST",
      "response" : {
        "variables" : [ null, null ],
        "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
      },
      "name" : "Meta-Llama-3-8B-Instruct",
      "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
      "params" : [ {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      }, {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      } ],
      "display_name" : "display_name",
      "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
    }, {
      "request" : {
        "raw" : {
          "variables" : [ {
            "path" : "$.messages[0].content"
          }, {
            "path" : "$.messages[0].content"
          } ],
          "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
        },
        "type" : "RAW"
      },
      "method" : "POST",
      "response" : {
        "variables" : [ null, null ],
        "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
      },
      "name" : "Meta-Llama-3-8B-Instruct",
      "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
      "params" : [ {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      }, {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      } ],
      "display_name" : "display_name",
      "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
    } ]
  }, {
    "api_type" : "REST",
    "name" : "Meta",
    "description" : "description",
    "auth_action" : {
      "auth_type" : "API_KEY",
      "auth" : {
        "custom_keys" : {
          "keys" : [ null, null ]
        },
        "api_auth" : {
          "prefix" : "prefix",
          "keyName" : "Authorization",
          "location" : "header"
        }
      }
    },
    "version" : "version",
    "actions" : [ {
      "request" : {
        "raw" : {
          "variables" : [ {
            "path" : "$.messages[0].content"
          }, {
            "path" : "$.messages[0].content"
          } ],
          "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
        },
        "type" : "RAW"
      },
      "method" : "POST",
      "response" : {
        "variables" : [ null, null ],
        "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
      },
      "name" : "Meta-Llama-3-8B-Instruct",
      "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
      "params" : [ {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      }, {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      } ],
      "display_name" : "display_name",
      "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
    }, {
      "request" : {
        "raw" : {
          "variables" : [ {
            "path" : "$.messages[0].content"
          }, {
            "path" : "$.messages[0].content"
          } ],
          "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
        },
        "type" : "RAW"
      },
      "method" : "POST",
      "response" : {
        "variables" : [ null, null ],
        "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
      },
      "name" : "Meta-Llama-3-8B-Instruct",
      "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
      "params" : [ {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      }, {
        "attribute" : [ {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        }, {
          "required_input" : true,
          "canonical_name" : "choices[0].value",
          "prefix" : "prefix",
          "name" : "name",
          "description" : "description",
          "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
          "optional" : true,
          "location" : "location",
          "label" : "label",
          "secure" : true,
          "value" : {
            "number" : "number",
            "boolean" : "boolean",
            "min" : "min",
            "string" : "string",
            "max" : "max",
            "type" : "TEXT"
          }
        } ],
        "type" : "HEADERS"
      } ],
      "display_name" : "display_name",
      "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK ConnectorList

400

Bad request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

post /custommodel

Creates Custom Model (custommodelPost)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Connector (optional)

Body Parameter —

Request headers

Return type

Connector

Example data

Content-Type: application/json

{
  "api_type" : "REST",
  "name" : "Meta",
  "description" : "description",
  "auth_action" : {
    "auth_type" : "API_KEY",
    "auth" : {
      "custom_keys" : {
        "keys" : [ null, null ]
      },
      "api_auth" : {
        "prefix" : "prefix",
        "keyName" : "Authorization",
        "location" : "header"
      }
    }
  },
  "version" : "version",
  "actions" : [ {
    "request" : {
      "raw" : {
        "variables" : [ {
          "path" : "$.messages[0].content"
        }, {
          "path" : "$.messages[0].content"
        } ],
        "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
      },
      "type" : "RAW"
    },
    "method" : "POST",
    "response" : {
      "variables" : [ null, null ],
      "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
    },
    "name" : "Meta-Llama-3-8B-Instruct",
    "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
    "params" : [ {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    }, {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    } ],
    "display_name" : "display_name",
    "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
  }, {
    "request" : {
      "raw" : {
        "variables" : [ {
          "path" : "$.messages[0].content"
        }, {
          "path" : "$.messages[0].content"
        } ],
        "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
      },
      "type" : "RAW"
    },
    "method" : "POST",
    "response" : {
      "variables" : [ null, null ],
      "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
    },
    "name" : "Meta-Llama-3-8B-Instruct",
    "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
    "params" : [ {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    }, {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    } ],
    "display_name" : "display_name",
    "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Connector

400

Bad request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

delete /custommodel/vendors/{vendorName}/models/{modelName}

Deletes Custom Model (custommodelVendorsVendorNameModelsModelNameDelete)

Path parameters

vendorName (required)

Path Parameter — Vendor Name

modelName (required)

Path Parameter — Model Name

Request headers

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Successfully processed no content

400

Bad request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

get /custommodel/vendors/{vendorName}/models/{modelName}

Gets Custom Model Information (custommodelVendorsVendorNameModelsModelNameGet)

Path parameters

vendorName (required)

Path Parameter — Vendor Name

modelName (required)

Path Parameter — Model Name

Request headers

Return type

Connector

Example data

Content-Type: application/json

{
  "api_type" : "REST",
  "name" : "Meta",
  "description" : "description",
  "auth_action" : {
    "auth_type" : "API_KEY",
    "auth" : {
      "custom_keys" : {
        "keys" : [ null, null ]
      },
      "api_auth" : {
        "prefix" : "prefix",
        "keyName" : "Authorization",
        "location" : "header"
      }
    }
  },
  "version" : "version",
  "actions" : [ {
    "request" : {
      "raw" : {
        "variables" : [ {
          "path" : "$.messages[0].content"
        }, {
          "path" : "$.messages[0].content"
        } ],
        "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
      },
      "type" : "RAW"
    },
    "method" : "POST",
    "response" : {
      "variables" : [ null, null ],
      "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
    },
    "name" : "Meta-Llama-3-8B-Instruct",
    "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
    "params" : [ {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    }, {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    } ],
    "display_name" : "display_name",
    "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
  }, {
    "request" : {
      "raw" : {
        "variables" : [ {
          "path" : "$.messages[0].content"
        }, {
          "path" : "$.messages[0].content"
        } ],
        "body" : "{\"model\": \"gpt-35-turbo\",\"messages\":[{\"role\":\"system\",\"content\":\"What is the capital of France?\"}],\"max_tokens\":500,\"temperature\":0.7,\"frequency_penalty\":0,\"presence_penalty\":0,\"top_p\":0.95,\"stop\":null}"
      },
      "type" : "RAW"
    },
    "method" : "POST",
    "response" : {
      "variables" : [ null, null ],
      "body" : "{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion\",\"created\":1677652288,\"model\":\"gpt-35-turbo\",\"system_fingerprint\":\"fp_44709d6fcb\",\"choices\":[{\"index\":0,\"message\":{\"role\":\"assistant\",\"content\":\"\\n\\nHello there, how may I assist you today?\"},\"logprobs\":null,\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":9,\"completion_tokens\":12,\"total_tokens\":21}}"
    },
    "name" : "Meta-Llama-3-8B-Instruct",
    "description" : "The Llama 3 instruction tuned models are optimized for dialogue use cases",
    "params" : [ {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    }, {
      "attribute" : [ {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      }, {
        "required_input" : true,
        "canonical_name" : "choices[0].value",
        "prefix" : "prefix",
        "name" : "name",
        "description" : "description",
        "annotations" : [ "REQUEST_PARAMETER", "REQUEST_PARAMETER" ],
        "optional" : true,
        "location" : "location",
        "label" : "label",
        "secure" : true,
        "value" : {
          "number" : "number",
          "boolean" : "boolean",
          "min" : "min",
          "string" : "string",
          "max" : "max",
          "type" : "TEXT"
        }
      } ],
      "type" : "HEADERS"
    } ],
    "display_name" : "display_name",
    "uri" : "https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Connector

400

Bad request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Models

Methods

Action
Attribute
AuthAction
AuthKey
AwsSignatureV4
Connector
ConnectorList
CustomKeys
Error
Param
Request
Response
Value
Variable

`Action` Up

Describes Model information

name (optional)

String Name of the model

example: Meta-Llama-3-8B-Instruct

description (optional)

String Description of the model

example: The Llama 3 instruction tuned models are optimized for dialogue use cases

method (optional)

String HTTP method. Should be always POST

example: POST

uri (optional)

String URI of the REST API. URI can contain parameters that will be replaced by the user input. Parameter can either be a PATH_PARAM variable or a QUERY_PARAM variable. You can also add HEADERS that are associated with this API request. In the example, deploymentId and projectId are a PATH_PARAM variable and apiVersion is a QUERY_PARAM variable.

example: https://{projectId}.openai.azure.com/openai/deployments/{deploymentId}/chat/completions?api-version={apiVersion}

params (optional)

array[Param] List of parameters that are used in the API request. Parameters can be either HEADERS, PATH_PARAM or QUERY_PARAM parameters.

request (optional)

Request

response (optional)

Response

display_name (optional)

String

`Attribute` Up

name (optional)

String

label (optional)

String

description (optional)

String

required_input (optional)

Boolean

optional (optional)

Boolean

value (optional)

Value

location (optional)

String

prefix (optional)

String

secure (optional)

Boolean

annotations (optional)

array[String]

Enum:

canonical_name (optional)

String Json path to the variable in the AAI canonical schema. Use choices[0].value to populate LLM response, use choices[0].promptTokens to populate number of tokens consumed by prompt, use choices[0].completionTokens to populate number of tokens consumed for generating response, use choices[0].totalTokens to populate total tokens consumed to fulfill the request.

example: choices[0].value

`AuthAction` Up

auth_type (optional)

String Type of authentication. API_KEY for API Key, OAUTH2 for OAuth2, CUSTOM_KEYS for multiple keys.

Enum:

API_KEY

OAUTH2

CUSTOM_KEYS

example: API_KEY

auth (optional)

Object

`AuthKey` Up

location (optional)

String valid value is "header"

example: header

keyName (optional)

String Name of the authentication key. For example, "Authorization"

example: Authorization

prefix (optional)

String Prefix to be added to the key. For example, "Bearer "

`AwsSignatureV4` Up

accessKey (optional)

AuthKey

secretKey (optional)

AuthKey

sessionToken (optional)

AuthKey

`Connector` Up

Describes Vendor and associated models information

name (optional)

String Name of the vendor

example: Meta

description (optional)

String

version (optional)

String Used for future reference. Set it to "1".

auth_action (optional)

AuthAction

api_type (optional)

String Type of API. Should be always REST.

example: REST

actions (optional)

array[Action]

`ConnectorList` Up

Describes list of vendors and associated models information

connectors (optional)

array[Connector]

`CustomKeys` Up

keys (optional)

array[AuthKey]

`Error` Up

code (optional)

String Error code

details (optional)

String Error detail

message (optional)

String Message description.

`Param` Up

type (optional)

String

Enum:

HEADERS

PATH_PARAM

QUERY_PARAM

attribute (optional)

array[Attribute]

`Request` Up

Describes Request object

type (optional)

String

Enum:

RAW

raw (optional)

Object

`Response` Up

body (optional)

String Sample (JSON) Response body. This is the body that will be received from the vendor API. The body can contain variables that will be displayed as LLM response or other parameters like token usage which is used for tracking.

example: {"id":"chatcmpl-123","object":"chat.completion","created":1677652288,"model":"gpt-35-turbo","system_fingerprint":"fp_44709d6fcb","choices":[{"index":0,"message":{"role":"assistant","content":"\n\nHello there, how may I assist you today?"},"logprobs":null,"finish_reason":"stop"}],"usage":{"prompt_tokens":9,"completion_tokens":12,"total_tokens":21}}

variables (optional)

array[Variable] List of variables that are used in the Automation Anywhere response. Must include variable representing LLM Response. Other variables could be input, output, total tokens consumed by the model.

`Value` Up

Describes type and value of the attribute

type (optional)

String

Enum:

TEXT

TEXTAREA

DECIMAL

INTEGER

JSON

string (optional)

String Value of the parameter. Used for TEXT, TEXTAREA and JSON types.

number (optional)

String Value of the parameter. Used for DECIMAL and INTEGER types.

boolean (optional)

String

min (optional)

String Minimum value for the parameter. Used for DECIMAL and INTEGER types.

max (optional)

String Maximum value for the parameter. Used for DECIMAL and INTEGER types.

`Variable` Up

path (optional)

String Json path to the variable in the request/response body

example: $.messages[0].content

attribute (optional)

Attribute

Access

Table of Contents

Consumes

Request body

Request headers

Return type

Example data

Produces

Responses

200

400

401

403

404

500

Consumes

Request body

Request headers

Return type

Example data

Produces

Responses

200

400

401

403

404

500

Path parameters

Request headers

Produces

Responses

204

400

401

403

404

500

Path parameters

Request headers

Return type

Example data

Produces

Responses

200

400

401

403

404

500

Table of Contents

Automation 360

AI Agent Studio API