POST - /ai/action/execute/{actionConfiguration} + /ai/actions/{actionConfiguration}/execute
Executes an AI action using the specified Action Configuration identifier.
@@ -134520,13 +134523,13 @@Action executed successfuly
+Action executed successfuly.
Error - the request is invalid
+Error - the request is invalid.
Error - the given Action Configuration identifier does not exist
+Error - the given Action Configuration identifier does not exist.
file_copy
-
+
{
"GenerateAltText": {
"Image": {
@@ -134663,17 +134666,17 @@ Types
file_copy
-
+
{
"RefineText": {
"Text": {
@@ -134685,20 +134688,20 @@ Types
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
<GenerateAltText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Image>
@@ -134709,17 +134712,17 @@ Types
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
<RefineText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Text>
@@ -134730,15 +134733,15 @@ Types
Code: 200
+ + file_copy + +
+
+ {
+ "AltText": {
+ "_media-type": "application/vnd.ibexa.api.ai.AltText+json",
+ "Text": {
+ "_media-type": "application/vnd.ibexa.api.ai.Text+json",
+ "text": [
+ "A close-up of a fluffy orange and white cat peacefully grooming itself, its eyes closed and tongue extended. The background is blurred with soft green tones, creating a serene atmosphere."
+ ]
+ }
+ }
+}
+
+
+ + file_copy + +
+
+ {
+ "RefineText": {
+ "_media-type": "application/vnd.ibexa.api.ai.RefineText+json",
+ "Text": {
+ "_media-type": "application/vnd.ibexa.api.ai.Text+json",
+ "text": [
+ "Here are some of the fastest animals on earth:\n\n1. Peregrine Falcon: Known for its incredible diving speeds, the peregrine falcon can reach speeds of over 240 miles per hour while hunting its prey.\n\n2. Cheetah: With its sleek build and powerful legs, the cheetah is the fastest land animal, reaching speeds of up to 70 miles per hour in short bursts.\n\n3. Sailfish: Considered the fastest swimmer in the ocean, the sailfish can reach speeds of up to 68 miles per hour while hunting for fish.\n\n4. Pronghorn Antelope: Native to North America, the pronghorn antelope is the fastest land mammal in the Western Hemisphere, capable of running at speeds of up to 60 miles per hour.\n\n5. Black Marlin: One of the fastest fish in the sea, the black marlin can swim at speeds of up t
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<AltText media-type="application/vnd.ibexa.api.ai.AltText+xml">
+ <Text media-type="application/vnd.ibexa.api.ai.Text+xml">
+ <text>A fluffy orange and white cat is lounging while gently licking its paw. The cat's eyes are closed and it appears relaxed, with a soft focus background.</text>
+ </Text>
+</AltText>
+
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<RefineText media-type="application/vnd.ibexa.api.ai.RefineText+xml">
+ <Text media-type="application/vnd.ibexa.api.ai.Text+xml">
+ <text>Here are some of the fastest animals on earth, demonstrating incredible speed and agility in their natural habitats. The cheetah holds the title for the fastest land animal, reaching speeds of up to 70 miles per hour in short bursts. The peregrine falcon is the fastest bird, diving at speeds of over 240 miles per hour while hunting for prey. In the water, the sailfish is known for its impressive speed, swimming at up to 68 miles per hour to catch fish. These animals have adapted to their environments, using their speed to survive and thrive in the wild.</text>
+ </Text>
+</RefineText>
+
+
+ + GET + /ai/actions +
+Returns a list of action configurations.
+ +Accept
+If set, the list is returned in XML or JSON format.
+| Property | +Value | +
|---|---|
| Type | ++ + + string + + + + + | +
| Examples | +
+ application/vnd.ibexa.api.ai.ActionConfigurationList+json
+application/vnd.ibexa.api.ai.ActionConfigurationList+xml
+
+ |
+
| Property | +Type | +Value | +
|---|---|---|
| + limit + | ++ + + integer + + + + + | +
+ The number of results per page. + + |
+
| + page + | ++ + + integer + + + + + | +
+ The page for which the results should be returned. + + |
+
| + enabled + | ++ + + integer + + + + + | +
+ Return only enabled (1) or disabled (0) action configurations. + + |
+
| + action_type_identifier + | ++ + + string + + + + + | +
+ Return action configurations for the specified action type identifier. + + |
+
| + query + | ++ + + string + + + + + | +
+ Return action configurations with identifier matching the given value, or the name starting with given value. + + |
+
| Code | +Description | +
|---|---|
| + + 200 + + | ++ + | +
| Type | +Description | +
|---|---|
| + + ActionConfigurationListWrapper + + | +Wrapper object for a list of action configurations. | +
Code: 200
+ + file_copy + +
+
+ {
+ "ActionConfigurationList": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
+ "_href": "/api/ibexa/v2/ai/actions",
+ "ActionConfiguration": [
+ {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
+ "identifier": "gen_alt_text",
+ "name": "Generate alternative text",
+ "description": "",
+ "enabled": true,
+ "ActionType": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
+ "identifier": "generate_alt_text",
+ "name": "Generate alternative text",
+ "inputIdentifier": "image",
+ "outputIdentifier": "text",
+ "options": {
+ "width": 512,
+ "height": 512,
+ "image_quality": 85
+ }
+ },
+
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions">
+ <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
+ <identifier>gen_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <description></description>
+ <enabled>1</enabled>
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>generate_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <inputIdentifier>image</inputIdentifier>
+ <outputIdentifier>text</outputIdentifier>
+ <options>
+ <width>512</width>
+ <height>512</height>
+ <image_quality>85</image_quality>
+ </options>
+ </ActionType>
+ <actionTypeOptions>
+ <max_length>140</max_length>
+ </actionTypeOptions>
+
+
+ + POST + /ai/actions +
+Returns a list of action configurations, the same data as the GET endpoint.
+ +Accept
+Specifies the expected response type. If set, the list is returned in XML or JSON format.
+| Property | +Value | +
|---|---|
| Type | ++ + + string + + + + + | +
| Examples | +
+ application/vnd.ibexa.api.ai.ActionConfigurationList+json
+application/vnd.ibexa.api.ai.ActionConfigurationList+xml
+
+ |
+
Content-Type
+Specifies the input type.
+| Property | +Value | +
|---|---|
| Type | ++ + + string + + + + + | +
| Examples | +
+ application/vnd.ibexa.api.ai.ActionConfigurationListInput+json
+application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml
+
+ |
+
| Code | +Description | +
|---|---|
| + + 200 + + | ++ + | +
| Type | +Description | +
|---|---|
| + + ActionConfigurationListInputWrapper + + | +Wrapper object for ActionConfigurationListInput. | +
| + + ActionConfigurationListWrapper + + | +Wrapper object for a list of action configurations. | +
+ file_copy + +
+
+ {
+ "ActionConfigurationListInput": {
+ "query": "Proofread",
+ "action_type_identifier": "refine_text",
+ "enabled": true,
+ "limit": 10,
+ "page": 1
+ }
+}
+
+
+ + file_copy + +
+
+ <ActionConfigurationListInput media-type="application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml">
+ <query>Proofread</query>
+ <action_type_identifier>refine_text</action_type_identifier>
+ <limit>10</limit>
+ <enabled>1</enabled>
+ <page>1</page>
+</ActionConfigurationListInput>
+
+
+ Code: 200
+ + file_copy + +
+
+ {
+ "ActionConfigurationList": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
+ "_href": "/api/ibexa/v2/ai/actions",
+ "ActionConfiguration": [
+ {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
+ "identifier": "gen_alt_text",
+ "name": "Generate alternative text",
+ "description": "",
+ "enabled": true,
+ "ActionType": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
+ "identifier": "generate_alt_text",
+ "name": "Generate alternative text",
+ "inputIdentifier": "image",
+ "outputIdentifier": "text",
+ "options": {
+ "width": 512,
+ "height": 512,
+ "image_quality": 85
+ }
+ },
+
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions">
+ <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
+ <identifier>gen_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <description></description>
+ <enabled>1</enabled>
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>generate_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <inputIdentifier>image</inputIdentifier>
+ <outputIdentifier>text</outputIdentifier>
+ <options>
+ <width>512</width>
+ <height>512</height>
+ <image_quality>85</image_quality>
+ </options>
+ </ActionType>
+ <actionTypeOptions>
+ <max_length>140</max_length>
+ </actionTypeOptions>
+
+
+ + GET + /ai/actions/{identifier} +
+Returns an action configuration with specified identifier.
+ +Accept
+If set, the list is returned in XML or JSON format.
+| Property | +Value | +
|---|---|
| Type | ++ + + string + + + + + | +
| Examples | +
+ application/vnd.ibexa.api.ai.ActionConfiguration+json
+application/vnd.ibexa.api.ai.ActionConfiguration+xml
+
+ |
+
| Code | +Description | +
|---|---|
| + + 200 + + | ++ + | +
| Type | +Description | +
|---|---|
| + + ActionConfiguration + + | ++ |
Code: 200
+ + file_copy + +
+
+ {
+ "ActionConfiguration": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
+ "identifier": "gen_alt_text",
+ "name": "Generate alternative text",
+ "description": "",
+ "enabled": true,
+ "ActionType": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
+ "identifier": "generate_alt_text",
+ "name": "Generate alternative text",
+ "inputIdentifier": "image",
+ "outputIdentifier": "text",
+ "options": {
+ "width": 512,
+ "height": 512,
+ "image_quality": 85
+ }
+ },
+ "actionTypeOptions": {
+ "max_length": 140
+ },
+ "actionHandlerIdentifier": "openai-image-to-text",
+ "actionHandlerOptions": {
+ "max_tokens": 4000,
+ "temperature": 1,
+ "prompt": "",
+ "model": "gpt-4-turbo"
+ },
+ "createdAt": "2025-02-06T
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
+ <identifier>gen_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <description></description>
+ <enabled>1</enabled>
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>generate_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <inputIdentifier>image</inputIdentifier>
+ <outputIdentifier>text</outputIdentifier>
+ <options>
+ <width>512</width>
+ <height>512</height>
+ <image_quality>85</image_quality>
+ </options>
+ </ActionType>
+ <actionTypeOptions>
+ <max_length>140</max_length>
+ </actionTypeOptions>
+ <actionHandlerIdentifier>openai-image-to-text</actionHandlerIdentifier>
+ <actionHandlerOptions>
+ <max_tokens>4000</max_tokens>
+ <temperature>1</temperature>
+ <prompt></prompt>
+
+
+ + GET + /ai/action-types +
+Returns a list of AI action types.
+ +Accept
+If set, the list is returned in XML or JSON format.
+| Property | +Value | +
|---|---|
| Type | ++ + + string + + + + + | +
| Examples | +
+ application/vnd.ibexa.api.ai.ActionTypeList+json
+application/vnd.ibexa.api.ai.ActionTypeList+xml
+
+ |
+
| Code | +Description | +
|---|---|
| + + 200 + + | ++ + | +
| Type | +Description | +
|---|---|
| + + ActionTypeListWrapper + + | +JSON object with only the ActionTypeList property. | +
Code: 200
+ + file_copy + +
+
+ {
+ "ActionTypeList": {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionTypeList+json",
+ "_href": "/api/ibexa/v2/ai/action-types",
+ "ActionType": [
+ {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
+ "identifier": "transcribe_audio",
+ "name": "Transcribe audio",
+ "inputIdentifier": "audio",
+ "outputIdentifier": "text",
+ "options": {}
+ },
+ {
+ "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
+ "identifier": "generate_alt_text",
+ "name": "Generate alternative text",
+ "inputIdentifier": "image",
+ "outputIdentifier": "text",
+ "options": {
+ "width": 512,
+ "height": 512,
+ "image_quality": 85
+ }
+ },
+ {
+ "_media-type": "app
+
+ + file_copy + +
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<ActionTypeList media-type="application/vnd.ibexa.api.ai.ActionTypeList+xml" href="/api/ibexa/v2/ai/action-types">
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>transcribe_audio</identifier>
+ <name>Transcribe audio</name>
+ <inputIdentifier>audio</inputIdentifier>
+ <outputIdentifier>text</outputIdentifier>
+ <options/>
+ </ActionType>
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>generate_alt_text</identifier>
+ <name>Generate alternative text</name>
+ <inputIdentifier>image</inputIdentifier>
+ <outputIdentifier>text</outputIdentifier>
+ <options>
+ <width>512</width>
+ <height>512</height>
+ <image_quality>85</image_quality>
+ </options>
+ </ActionType>
+ <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
+ <identifier>refine_text</ident
+
+