Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ai-interfaces/port-ai/api-interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Learn more about [LLM Provider Management](/ai-interfaces/port-ai/llm-providers-

### Specifying Provider and Model

When making API requests, you can include `provider` and `model` parameters (if none specified, your organization's default will be used). See the [Invoke an agent](/api-reference/invoke-an-agent) API reference for detailed example.
When making API requests, you can include `provider` and `model` parameters (if none specified, your organization's default will be used). See the [Invoke an agent](/api-reference/invoke-a-specific-agent) API reference for detailed example.

### Default Behavior

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This route allows you to change the configuration of a specific LL
sidebar_label: "Change a specific provider configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWUtz4kYQ/iuqqRySCjLgsi/c8CYHV7xZl9ebi5ekBqlBs5Y0yjzYxSr993SPJBhAGDvr2jhbXECMpl/f9GuaksWgIyUKI2TORuw2ETpQ0hoIeJrKzzpYShsYGUQJz+cQmASCSOYzMbeKE00gZwEPdAGRmIkouLp6GxRKLkQM6oT1mOFzzUZ3bHzJJj2mIbJKmCWulGwKXIHCx0mFrxT8bUGbCxnj25KhDAO5oUdeFKmInLD+J01alkxHCWScnsyyANRbTj9BZFAgCi9AGQG6YYOqOi758t3Myd2mMMKktDDOTYLEItrhwgvxGyzfQ6TA/M4z8ORqo0Q+R4pM5FeQz03CRsOqqu0RCmIyfoce7eVxLMgknl57smY81VD19iv5roAcsXzFGo4frILgpfQkNbW0KoInbo+hSOUyQ9+5jL8ahS3pW9z/PUYXECsZ3e/CE0WgNepwGT8LI+02j1vqZ+I7F3VQPbYRNeXGgKIc8ecdDx8m5WkVuoefw48f43JY/cCQ29xyFSsu0ssYQcKUQBG+zdrf9wco3Sl/53A6sXnM9pVtBw5qgpLkApTCpKUP55RMxpB27vPVnRcmPMe1KOU2hhDzVg4mPAtPB6fng/PhGSm1ybemOCgecj5NwfftqZQp8Ny554zbFLOmURYIwEf9c79u306Jr3vde0FFaEPBFToOurl2lWKnyrS8caugSMCSpZYoKXehxhY8FTE38FdEiEaupPpescoLO4xXMQe5zch9UL2cC1zglE7D9U+vSE3XWUQqwyatVhipyVqpthpvaOIQcVVXFzLX9aGeDgb0tdkQ/FKDGNw0O8mlX6Y2y/tuZFEnd2qH6FeGvTyM+72q6j2pp3h11fl7U+j76guOXcB/3wX0/HjOJSWg6uBZHSgqk2Nv8X/uLWYzKuILeHs8lW92KqijAuyh4rHpykYzqTKObxj1WaERGOBrkotlZ5axRfxchg1JJ8OtjOT1Vy1Gu65zIPdssZT3bNUGHaIk2rPX0bhhlpPdeT7DrMznHXXIFWaDBaAzuroNL6tOvGrpT4Pr7AjX0+E6P3rX0+Fy6phExnTzss46uo2NWH8x7KdpFrbpQvfL9rFy/YtatNdOq1IkSIwp9Kjfx+bzhC4mJ0Iy6kd231q93uANWd8T4DWm7ah1BULd0a4viWOLOivxwJs7q7tHJsApr5FNdIg36wntr194VqSwNWHd6eG9c9jogdZdzqoCrsqLKyGPF6rNvZV/X2uoRT6Tztpm3naN8ATja5pHLtpOkw1PBqRZIbXJuHPRBow39ajbm2q3J7U5+naVzwsKb2r98nP0+twMfDH9IuXChYRzhbLxsDu2GOLGDR/D36NVfULXSNBW2lmWU67hg0qripbrMQa5Xix0g6Tz6B67Ry/ZN9jAVUtKOa9bcCWItJvNXpx+vGki7adgn5Wty+ZLX2ar2so812o3Lks61K/f1JLCW2KyJt9JUBRZNQXdIQrz6N6JF+TXH25phtD8bUGejYuKf6YKjp9OU+kMdw7v1kqWohNYl7NYzdK1RZbO0Y/RexejzYM3Z9jEYjt4azvo07u/bJKUZR2tVcW8M7awn6JBtt1NRzNBrf8Bwv0m8Q==
api: eJztWc1y2zYQfhUOpod2KlqSx77oJqc9eOo0HsfpxVE7ELkSEYMEC4BKZA7fvbsgKUESZdmNJ3Uzutg0gN39drF/WJcsBhNpkVuhMjZit4kwgVaFhYBLqT6bYKmKwKogSng2h8AmEEQqm4l5oTnRBGoW8MDkEImZiIKrq7dBrtVCxKBPWI9ZPjdsdMdoPeUZn0MKmWWTHjMQFVrYJe6WbApcg8bPSYVbGv4uwNgLFeNuyVCeJSL85HkuReQE9z8ZQlwyEyWQcvqyyxxQBzX9BJFF4QgkB20FmIYNwnZcsuW7mZO7TWGFlbQwzmyCxCLa4cJz8Rss30Okwf7OU/DkGqtFNkeKVGRXkM1twkbDqqr1ERpiMsQOPerL41iQSlxee7JmXBqoevtBvsshG1++ZoTjh0JD8FI4CaZRhY7gicdjyKVaksNdxl9thS3pW9z/vY0uINYqut81TxSBMYjhMn6WjYw7PG6pn2nfuaiD6rGDiJRbC5ryxZ93PHyYlKdV6D5+Dj9+jMth9QNDbvOC61hzIS9jNBKmB4rwbdb+uT9Am075O5fTaZvHdF/pduCiJihJLUBrTGDmcE5JVQyy85wPd57b8BzXIsmLGELMWxnY8Cw8HZyeD86HZwRqk29NcVA8ZHwqwfftqVISeObcc8YLiVnT6gLIgI/6535s3w7E1233XhAIHci5RsdBNzeuUuxUmZY3HhUUCViy9BIlZS7U2IJLEXMLf0Vk0ciVV98rVnlhh/Eq5iArUnIfhJdxgQuc0mm4/tMrUtN1FlEa62uLCiM1WYNqK/MGEmcRV3VNrjJTX+rpYEC/NpuDX2ojBjfNSXLpl6nN6r7bsojJ3doh+pViL2/G/V5V9Z7UU7y66vy9Afq++oJjF/DfdwE9P54zRQmoOnhXB4rK5Nhb/J97i9mMivgC3h5v5ZvdCmLUgD1UPLZd2WimdMpxh1GfFVqBAb4muVh2Zpkij5/LsCHpZLiVkbz+qrXRruscyD1bLNU9W7VBhyiJ9ux1NG6Y5VR3nk8xK/N5Rx1yhdliAeiMrm7Fy6rTXrX0p5nr7Giup5vr/OhdTzeXg2MTFdPLq3Da0WtsxPqLYV/KNGzThemX7Wfl+he9aJ+dhZZIkFibm1G/j83nCT1MToRi1I/s7hZmfcAbsr4ng9c2bUetKyPUHe36kTguELMWD7x5s7p3ZAKc8hrpRJd4s57Q/vqFp7mErQnrTg/v3cNGD7TuclYVcFVeXAl5vFBtnq3891pDLbKZcto287ZrNE8wvqZ55KLtNNnwZEDIcmVsyp2LNsZ4U4+9vQl3e1ObY3BX+byg8KbWLz9Tr+/NwhfbzyUXLiScK5SNh92xxRAPbvgY/j1a1Sd0jQR1pZNlOeUGPmhZVbRcjzHI9WJhGks6j+6xe/SSfYMNXC0IlPO6BdeCSLvZ7LXTjzdNpP0U7NOyddls6ctsoa3Uc61247KEod5+U0sKb4nJmnwnQVFk1RT0hsjto2cnXpBff7ilGULzbwvybFzU/DNVcPzpkCqnuHN4t1YyiU5QuJzFapauLSroHv0YvXcx2nx4c4ZNW2wHb60H/fTeL5skZVlHa1Ux744L2E/RWLY9TVczQdT/AFapK4k=
sidebar_class_name: "put api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This route allows you to change the default LLM provider and model
sidebar_label: "Change default LLM provider and model"
hide_title: true
hide_table_of_contents: true
api: eJzVVUtT2zAQ/isencmLIZfcQtsDUzqToXBictjYm1hEtlQ9AsHj/95d2SEOdWE65dBeEln70Lf7fVpVIkOXWmm81KWYidtcusTq4DEBpfSjS/Y6JF4naQ7lBhOfY5LhGoLyyfX1t8RYvZMZ2gTKLCl0hmoozoSHjROzezG/Essz4TANVvo97VRihWDR0nJZk8nij4DOX+qMrJVIdemx9LwEY5RMgWGNHhxjq4RLcyyAV35vkNDq1QOmng4kGAatl+jYegDV8XTeynJDnliGgqGRfwmSNuA5WBwcP0ufUzKZ0nqFmdXplvNr68WyPhOxxLfybowfTOk7VRAyHBDyEv3gYnA+Pp+Op5MLylI3dUuLGUe8oD1kp75AlkkuHdSiU9kalMP6NN7bgHHDGV26pv7z8Zj/Tpn93LJ203oyxo9pt952fFZaK4RSNJjowP+eLjJaBI/Z3PdlWmtbAFlERj4DLwsUx5DL/a8hZA0m+9OEbUhvwr8V1Gm45g623L0rRYqd/htqQ2t1j4RYBOgcbLDXlqEHqVzfsf2FV3Vvv5rT329XhONzTZHChFgd+Jw+RrvJSKlicCDPjdox6wRPULujrThAgyVBi9x742ajERg5ZLUPpaZy+qzBHR06w/g7t7vp6GEkv7SAwr7ins4toeDveSDEVj5HwmhbMsM5AmuMK2IKb46T/MsTFEbh6dU+3uD2TrZXr+Z0ax1Pl56jxILgJvPFFfly1Y2gJsMx+xrtfAFRMC24T83D9PajJM5O9dl5aj7qyWta5/HJj4wCGTUZ2ahaiu/FbkKOJyRHXC3NRE5O1bFjVa3A4Z1Vdc3b1FnLryctd2AlrLhN9zyZWhJYF1tijLrRlDW4ZTjsrkLD6KsLx1ppIuZpisa/6bvsiHZxd8ujtn2wuXzatPDIM4N+Z4IWOnY5aivuVUJRJ0O8g6JJybKBwG3pqm4bVdcuuKiDqdx3AL6WY1MH/3JVvSFV1Wia+nnwb0y/jWg7e/BmPunlrn8C138mAw==
api: eJzVVclu2zAQ/RWBZ8tLEF98c5dD0RQw0uQU5DCWJhZjSmS5OHEE/XtnKDmWUzVB0Rzai01xFr6Z9zisRY4us9J4qSuxEFeFdInVwWMCSukHl+x1SLxOsgKqDSa+wCTHOwjKJxcX3xJj9U7maBOo8qTUOaqxGAkPGycWN4I9SqhggyVWXtyOhMMsWOn3ZK3FGsGipeVtQyaLPwI6/0HnZK1FpivPQbQEY5TMgCFO7h3jrIXLCiyBV35vkJDr9T1mng4nSAatl+jYegDY83TeympDnliFkmGSfwWSNuApWEyPn5UvKJnMaL3G3Opsy/m1pVKakYjlvpZ3Y3w6p+9MQcgxJeQV+vQ8PZuezafz2Tlladq6pcWcI57RHrJTXyDPJZcOatWr7A6Uw+Y03tuAccMZXbm2/rPplP9OWf7UMXjZeTLG92m33vZ81lorhEq0mOjA/54uMloEj/nSD2W607YEsoicfFIvSxTHkA/7X0PIGkz+pwm7kMGEfyuo03DNHey4e1OKFDv/N9SG1uoBCbEI0DkaR4O2HD1I5YaOHS68bgb71Z7+drsiHF9oihQmxOrAF/Qx2c0mSpXpgTw36UauEzxB7Y624gANlgQtCu+NW0wmYOSY1T6WmsoZsgZ3dOgN4+/c7rajh5H83AIK+4p7OreCkr+XgRBb+RQJo23JDBcIrDGuiCm8PE7yz49QGoWnV/t4g7s72V29htPd6Xi69BwlVgQ3Wa6+kC9X3QpqNp6yr9HO0+vC7h24j+0j9foDJUan+uw9Ne/1/LWt8/joJ0aBjJqMbNQdxTdiNyPHE5Ijro5mIqeg6tixrtfg8NqqpuFt6qzl15OWO7AS1tymG55MHQmsiy0xRt1oy0qvGA67q9Ay+uLCsVbaiGWWofGv+t72RLu6vuJR2z3YXD5tWnjgmUG/C0ELHbsctRX3aqGokyHeQdGmZNlA4Lb0VbeNqusWXNTBVO17AF/Ksa2Df7mqwZC6bjVN/Tz4t6bfRnSdPXgzn/RyNz8BBAUqmw==
sidebar_class_name: "put api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This route allows you to create or connect an LLM provider."
sidebar_label: "Create or connect an LLM provider"
hide_title: true
hide_table_of_contents: true
api: eJztWV9z2jgQ/yoezb0dDpBJXvKWtvfAXHrNNLl7SbmOsBdQkS2fJNMSj7/77coGZDAQmmmv6fGSeKTd1Wr3t/9QwWIwkRaZFSplV+x+KkygVW4h4FKqzyZYqDywKog0cFxUOohUmkJkA54GNzdvg0yruYhBn7EOs3xi2NUDux6wYYcZiHIt7AJXCjYCrkHj57DELQ3/5GDsKxXjbsFQpIXU0ifPMikiTup0PxnSqWAmmkLC3W66eDd28uwiA9RXjT6hLnS0sJIWeGqnWmUiwjVULQNtBRjiXSpK3zW3sVqkE6SENE9I8TX3sOyQWmMx8ehXpzUl80z8Dos7QBvZP3gCbSckIr2BdGKn7KpflpUFhIbYnbrJjxbicSzICFzeemeNuTSA3GoOWuNlzGHlEhWDbKXzVYgkz2MIDfnWhhfhee/8snfZvyBVmvJ2Uh7UBFI+knTcinCklASeImUMY55LRIDVOZB99t3/edud4xTxrbSC0Aobhzy1G6hImnLxVSitWf9nEJ1kNrzcxmO1fALfUeDjj7mG8BkQbAj4pkAkIxiV6wieSB5DJtUiwXoyiJ8N843TN6SfguAlB8EIYq2i2Vfhf8l7FPSjCIxBfA3io/BvHPH1kvvI2JmIqonaR4iacmtBUwf49wMPH4fFeRm6j1/DDx/iol/+wlDaJOc61lzIQYwBIMaizUg+3V+gTev5W4HXapt9d1/d7dQs/SShOixLkpFxjf5FNBrX6K+b/43jkVQQYHGS0As8JHURweZcihhHlY/1nEIQ8RWrz3KJPVOpqcx93uvTv+Yw9Ka6XvC+pqxu8rRJZb931az9QqiTs+ch/iO6xM5msfcnJC8FKm1dNtvt70aq2z2J/ceN58+v0EvuiE418oeskX48p4oSUHnQVwcqx7AcfrsGuHNEDf7evfEe3V5Q1R+PqXbO4e3JK9/NK6ij+5U1vrZt2WisdMJxh1F7E1qBAb5mebVozTJ5Fh8rsGZpFbi7xVvaaBs6B3LPhkg1Y6s26BAn8V70ej9C44ZZTrXn+QSzMp+01CFXmC0WgNboar94Ubbaqzr9Kea6PJnr6eZy6tipQk7sj427HqdmgHXn/a6USbgMAOPKsJ4vh5ZcS6SaWpuZq24Xe6gz6q/PhGJUVrd3c7Mm8F5O7sjMlSWX7yerq1eN2Xruuc5RUy0eeT3xuNloCpzCk25Crnu/fnb57QtPMgnNYaIxG3i9/laH6jmlUeHXNXxftl3l0ypn+kOHWyHlx8rdtf6p5haNE1zfDlCt+bJdYv2zHilAnkm4g2VtiteH3qpc3vYiwHuBeu4LWOUcC19sN5NcOLQ7fxc1dh7YvI+ETfSgz6cEMNwtihE38KeWZUnL1XRLmIqFqY3kANphM3T/rnkXV3NSxMFpzrUgVvf61lmCgmRWIl5Xlw/vSfk171bgE3YrDmo2M7uXdugFz+27u3uaNuvnPkIJrmr+mXI9/kU9EUjOGQ48bq1gkqfYJVMyYJVMV0BzsqIfBjMXBvWHN5FiS+tpuBkf1UXor9fpNlmKokI+esKzdg67OWrTLqnJ/fSrxr8ESUek
api: eJztWUtz2zYQ/iscTG8VLcljX3xzkh48dRpP7PbiqBmIXEmIQYIFQCUyh/+9uyApgRIlWfEkjVNdbA6wC+zj25dQsBhMpEVmhUrZBbubCRNolVsIuJTqswkWKg+sCiINHBeVDiKVphDZgKfB9fXbINNqLmLQJ6zHLJ8adnHPaD3hKZ9CAqllox4zEOVa2AXuFmwMXIPGz1GJWxr+ycHYVyrG3YLh8ZaY8JNnmRQRJ9H6nwzJVzATzSDhbjddvJu48+wiA5RdjT+hXCSGsJIWeGpnWmUiwjUUMwNtBRjibYSm75rbWC3SKVJCmiekxIp7VPZIrImYevTL29on80z8DotbQHvZP3gCXTckIr2GdGpn7GJYlpUFhIbY3brOjxbicSzICFzeeHdNuDSA3GoOWqMyZr9wiYpBdtL5IkSS5zGEhvxsw7PwdHB6PjgfnpEo7fO2Uu6VBFI+lnTdknCslASeImUME55LRIDVOZB9dun/vO3eYYL4VlpCaImNfZ7aDlQkTbn4KpTWrP8ziE4zG55v4rFaPoLvIPDxx1xD+AwItg74pkAkIxiV6wieSB5DJtWCitBV/GyYr92+dvoxCF5yEIwh1ip6+Cr8N7wHQT+KwBjE11V8EP6NI75suA+MnamomqhdhCgptxY0dYN/3/PwcVSclqH7+DX88CEuhuUvDE+b5lzHmgt5FWMAiInoMpJP9xdo03n/RuB12maX7kvdjs3STxKqo7KkMzKu0b+IRuMa/VXzv3Y9kgoCLE4SeoGXpC4i2JxLEePY8rGeWQgivmD1XS6xZyo1lblPB0P61x6M3lTqBe9rykqTp00qu72rHroVQpmcPffxH9Al9taLvT8heSlQaeuy2XZ/t1Ld9knsP248f36BXnJHdKyRP2SN9OM5VZSAyr2+2lM5RuXo2zXAvQNq8PfujXfI9oKq/mRCtXMOb49e+W5eQRndL67xpe3KRhOlE447jNqb0AoM8BXLq0Vnlsmz+NADa5bOA7e3eI2NNqGzJ/esHake2LIN2sdJvGeDwY/QuGGWU915PsGszKcddcgVZosFoDO6uhUvyk57Vbc/xVznR3M93VxOHDtTyIn9sXHqcWoGWH8+7EuZhE0AGFeG9bwZWnItkWpmbWYu+n3soU6ovz4RilFZ3dzNzYrAezm5JTNXlmzeT5aqV43Zau65zFFSLR55PfG42WgGnMKTNCHXvV89u/z2hSeZhPYw0ZoNvF5/o0P1nNKq8KsavivbLvNplTP9ocOtkPAT5XStf6q5QeMElzdXKNa8aZfY8GRAApBnEu5gWZvi9b53K5e3vQjwXqCe+xpWOcfCF9vPJBcO7c7fRY2dezYfImEbPejzGQEMd4tizA38qWVZ0nI13RKmYmFqIzmA9tgDun/bvIurOQni4DTnWhCre33rNaCgM6sjXlfKh3ck/Ip3I/AJuxUHNZuZ3Uk78oLn5t3tHU2b9XMfoQRXNf9MuR7/opwIJOcMBx63VjDJU+ySKRmw6kxXQHOyoh8GDy4M6g9vIsWW1pNwPT4qReiv1+m2WYqiQj56wrN2Dts5atM21OR++lXjXxBrTDw=
sidebar_class_name: "post api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This route allows you to delete a specific LLM provider configurat
sidebar_label: "Delete a specific provider configuration"
hide_title: true
hide_table_of_contents: true
api: eJztVDtv2zAQ/isCpxZwLLtIF20GkiGoCwRpOgUeaOlsMaZF5ki6dQT+997pYSuNUmTo0KGLfeK9vvvuUYsCXI7KemUqkYn7UrkETfCQSK3ND5ccTUi8SQrQwI+Js5CrjcqT5fJrYtEcVAGY5KbaqG1AyXGmYiK83DqRPYjFjVhNhIM8oPJHeqnFGiQCkriKpLIS5Z5Co2uULi9hL0VWC3+0QIicR1VtKSJUYc8RjYVKKnqQzwHh4vxZ+RKNVTnJayjQ5DuxihOhuC4rfUnvFaXirw42vSA8BYVQiMxjAAaE4KypHDgG8Wl2yX8vSbqCjQzaJ3edJYWh+j1Unm2ltVrlDRHpo2OHkarM+hFyT44ExQJ61aYzu4HN2hgNshIxDmE+sBHBlEWhOIfUt4MQG6kdxMgul/8CdGobosHX/STNHpyTWxjVFeCl0m4s7XjhdRyhqc/+Hro+z2b/6XovXQ0cXxryFO1l4AJ5xzKRHuap1vuLfslcWvdiFHwK8NAve0BNDqX31mVpKq2aWoN+qgzVNKYN7mwwuCrfmPOW1v62nHggty9wPK/+IhBsVM9N10R3HUqQfA1icy02pnFXXrP9LeVLFrc3ZMqw27GYT2fMujXO72XT9i761asrOX4hxeTloNXnsfqLJ7hlwMNPn1otVTNfDal116sHcZiT4Ytu0Xd2uo9EcklFsmVdr6WD76hj5OenAMjnnMSDRCXXzBa1tFCO5aIblj/U+eGum76PyVtg+x5W3MCD1IG/SNxRRwdXPPKZ73rIGFr1Is/B+oHjq3XlGTqN8dX18vr+mhcmMDXDAdo1A9QJnGAU1++T1aLgXx7mUZe6bsczxpN9q3rTo6uyt2aaVrSOvwCE1a7f
api: eJztVE1v2zAM/SuGThuQxunQXXwr0B6GdUDRdaciB8VmYjWypVJSttTQfx/pj8Rp3aGHHXbYJZFFUiQfH18jCnA5KuuVqUUm7kvlEjTBQyK1Nj9dsjch8SYpQANfJs5CrtYqT25uviUWzU4VgElu6rXaBJT8zlzMhJcbJ7IHwV6VrOUGKqi9WM6Egzyg8nuyNmIFEgHpuIxkshJlRWnQtUaXl1BJkTXC7y1Qdc6jqjf0OtSh4teNhVoqupDPAeHs+Fn7Eo1VOZ1XUKDJt2IZZ0Jxj1b6ku5rSsVffQt0g/AUFEIhMo8BuCAEZ03twHERnxYX/HcK2BWsZdA+ues96RnCwnOv5Cut1SpvQUkfHQdMdGVWj5B7CqRSLKBXXTqzHfmsjNEgaxHjuMwHdqIyZVEoziH17eiJtdQOYuSQi3+hdBobosHX8yRLBc4RRyZtBXiptJtKO914EydgGrK/B67Pi8V/uN4LV1uOLw1Fik4luEHesUyku/NU6+psWDKXNsMxCpYC3A3LHlBTQOm9dVmaSqvm1qCfK0M9TVmDOzqMVOU7Y97BOmjLAQcK+wr74+pfBiob1XM7NdGrQwmS1SC2arE2bbjymv1vKV9yefuFXLnsjhbn8wWjbo3zpHPs3r9+9Uoxp9VSzE6J1hxp9RfluEPAwy+fWi1Vy68W1Kaf1YPYnZPjybToOzvoI4FcUpPs2TQr6eAH6hj5+ikAspzTcSdRyRWjRSMtlONz0ZPlD31+uOvZ9zF5q9hhhjUPcCd14C86bmmiIxWPLPP9DLmGznyZ52D9KPDVujKHDjS+ur65vr/mhQkMzZhA25ZA/YETTNb1klldFfzLZJ4MaZqOnjEe/DvTmxF9l4M3w7SkdfwNPGqzdw==
sidebar_class_name: "delete api-method"
info_path: api-reference/port-api
custom_edit_url: null
Expand Down
71 changes: 71 additions & 0 deletions docs/api-reference/general-purpose-ai-interactions.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: general-purpose-ai-interactions
title: "General-purpose AI interactions"
description: "This is a general-purpose endpoint that is not tied to any specific agent. Its purpose is to allow you to send requests directly to Port AI, enabling interactions and executions without being bound to a predefined agent context."
sidebar_label: "General-purpose AI interactions"
hide_title: true
hide_table_of_contents: true
api: eJztV99v4zYM/lcE7WEbECfprX0pMAzZDwzBNlzR67CHIhhkm4l1dSxPktPmgvzv91GyY6dJsD7sbQccerZFiuRH8iOzk16tnLx9lLO5XIxkTi6zuvbaVPJWPhTaCfxTYkUVWVUmdWNr40hQlddGV174QnkWqQyeNeXCG6GqrXA1ZXqpM6Gg6sdi7p3olCHOUmVpnsXWNPzicKGw9E9DDoK5tpT5cssnd8Z6MZuPYFKlpa5WAmbhS8Y+wjXo0QtlTXx91r4wjRcpsWRqmip6JGpLOS11BQ+DRyIzuObFj+VIOqhb7beAYSdTUpYsHhd74NG69KPJcbqTQany/KjqutSZYrOTj47h2kmXFbRW/OS3NQFAk35EIDBRW1OTBUCOTxtH9s6ade0Hss5b+CxPc0CC5b92Yk3OwXlhrIBXNsCTEkIzGU4QWbrt4BrL/UiWKqXSnXPn2MT78KBKGPAqyZVXQqWMoodtXW1MDJOhUnmuo/DdUUTHMez3IeKNzhnJt0Q4m4tOgaNCwGKJMH0owN4DMV+GSmuri/JR8BGZVU3p+yuedVkyNLgnZ7epatZc5HC5Uprj+NRYSvrXyheIR2d4TikHoE+cNGApF4hlbXIqzwXS3buqfXKD96xUTU4JyqEin1wn76bvbqY3V9fhFrd1ntZvzfsMPeGFWSJ8SDRtuYd2WzUIkksfsKEsUirURgMtFXrI1RDEMYoh4hF6Bl1lTUkjgaTBPTUK0pxC1SbfNiVfGrOe0kpXFWvCAxga9Nw4uBoAh5tcZ4f++wM4vS3fBxXB2La5Pio28VdB+BTKQTXerPE5A2dsW10CPuUyQWdsdEai5YNhsmedFr7NasYCUd6jocEueSS7LorTY4TljTnqHmWt2p5E87t2IU33tKIXgTvAF+wzLGcFuEZx/kJw4T5RKbTxWDwYUYJpOH5Lg3ZTG6XRt2UrPkJClxEEPn3MTdaswUABo8U3hfe1u51M8NmNuVzH2kyUTkK6lgq0MOGvidITs2Gk6PmHA/QJQ+++X6uqUeVXB8NJMPwtI6lRr2fbex+ZMSAFpAd81sG2uMQVS1U6enUD6puYMpQFOPDcBSY+YdPOPBxj5AMHwiAjite+dv5Ge1Se+cHKoZlg+rTPmkrjKtErnStHGadB21zs1PV0yv8d3/Zzy0T3rSRzwn8zM8zTQCYFxqSq0HzWmjMky6wVx8XZsxxMr8/PhgsUf5J0wxQZrf9rsqF6Pf3uC1xvh+vmS3W9Ha7gDhY/aGJouxCe8gXeJpsr8OGEG/mJwqpnNx2/NBYzXXYUqmrdMShCOHfauF5g0W+NHxjiiGK3O/Yjo9a/0YCjMJIKY/WnkCTZ8lhBivckjoLTdt+vnL+8qHVd0uuVsR+shw3vaOHq15x2cTnsJ8criJQns/vMJDwMwsfO7iIw8NKEQLVnB2XcO+/mEGeAY71ejadcDpwSTBkWb3H49dXPCax/w63+9ZAdLN7/l98kbQHx66QusUQwkKEmd21tP8rNFTeUDnUU6htVWXD542y3S5WjP2253/PnOCu56nPteMpfGIdDpN86GS84+4TCvzyVw6IU9scFv1jNToVfXaOuIdjbeMlP0afkge30uieEx30bNWZZRmEbuSy7GJDG3fsPD7z6tz/z1rEXrHrm/QF/Q6uYOhYnBMK3HdqvWjWBBGW8k3sYy2pxTAFPgQLaB46qO6q2Aw9fc0MMhP9yWGdVdrtIMMhxJx+PLmq00PbZAQ7w+jNq/57X
sidebar_class_name: "post api-method"
info_path: api-reference/port-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"General-purpose AI interactions"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/v1/ai/invoke"}
context={"endpoint"}
>

</MethodEndpoint>



This is a general-purpose endpoint that is not tied to any specific agent. Its purpose is to allow you to send requests directly to Port AI, enabling interactions and executions without being bound to a predefined agent context.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"schema":{"type":"string"},"in":"query","name":"invocation_identifier","required":false,"description":"A unique identifier for the invocation."}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"userPrompt":{"type":"string","description":"The user's message or query to be processed by Port AI."},"labels":{"type":"object","description":"Optional meta-data about the invocation.","additionalProperties":{"type":"string"}},"provider":{"type":"string","description":"The AI provider to use for this invocation. If not specified, the default provider will be used.","enum":["openai","azure-openai","anthropic","bedrock","port"]},"model":{"type":"string","enum":["gpt-5","claude-sonnet-4-20250514"]},"systemPrompt":{"type":"string","description":"A set of instructions that guides an AI's behavior and responses by providing its role, persona, and operational rules at the beginning of an interaction.","default":""},"executionMode":{"type":"string","description":"The execution mode for the invocation. Whether to automatically execute self-service actions.","enum":["Automatic","Approval Required"],"default":"Approval Required"},"tools":{"type":"array","description":"List of Regex values to match against the tools names. To learn more about the available tools, refer to the [documentation](https://docs.port.io/ai-interfaces/port-ai/overview?execution-modes=manual#available-tools).","items":{"type":"string"}}},"required":["userPrompt","tools"],"additionalProperties":false}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}}}}
>

</StatusCodes>



Loading