Create mission
Create a new mission definition
POST
/
ai
/
missions
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const mission = await client.ai.missions.create({ name: 'name' });
console.log(mission.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
mission = client.ai.missions.create(
name="name",
)
print(mission.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
mission, err := client.AI.Missions.New(context.TODO(), telnyx.AIMissionNewParams{
Name: "name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", mission.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.missions.MissionCreateParams;
import com.telnyx.sdk.models.ai.missions.MissionCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
MissionCreateParams params = MissionCreateParams.builder()
.name("name")
.build();
MissionCreateResponse mission = client.ai().missions().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
mission = telnyx.ai.missions.create(name: "name")
puts(mission)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$mission = $client->ai->missions->create(
name: 'name',
description: 'description',
executionMode: 'external',
instructions: 'instructions',
metadata: ['foo' => 'bar'],
model: 'model',
);
var_dump($mission);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:missions create \
--api-key 'My API Key' \
--name namecurl --request POST \
--url https://api.telnyx.com/v2/ai/missions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"execution_mode": "external",
"metadata": {}
}
'{
"data": {
"mission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"metadata": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const mission = await client.ai.missions.create({ name: 'name' });
console.log(mission.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
mission = client.ai.missions.create(
name="name",
)
print(mission.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
mission, err := client.AI.Missions.New(context.TODO(), telnyx.AIMissionNewParams{
Name: "name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", mission.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.missions.MissionCreateParams;
import com.telnyx.sdk.models.ai.missions.MissionCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
MissionCreateParams params = MissionCreateParams.builder()
.name("name")
.build();
MissionCreateResponse mission = client.ai().missions().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
mission = telnyx.ai.missions.create(name: "name")
puts(mission)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$mission = $client->ai->missions->create(
name: 'name',
description: 'description',
executionMode: 'external',
instructions: 'instructions',
metadata: ['foo' => 'bar'],
model: 'model',
);
var_dump($mission);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:missions create \
--api-key 'My API Key' \
--name namecurl --request POST \
--url https://api.telnyx.com/v2/ai/missions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"execution_mode": "external",
"metadata": {}
}
'{
"data": {
"mission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"metadata": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}