Skip to content

Commit

Permalink
Addressed comments: Mentions of SaltInput & SaltOutput, improved word…
Browse files Browse the repository at this point in the history
…ing in sections & links to support channel. Example cURL request fixed" [api-discord-updates d5a583a] Addressed comments: Mentions of SaltInput & SaltOutput, improved wording in sections & links to support channel. Example cURL request fixed
  • Loading branch information
jcooper-salt committed Jun 20, 2024
1 parent 7cfc758 commit da0cbe8
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 21 deletions.
13 changes: 0 additions & 13 deletions docs/deploy-to-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,8 @@
### Example cURL request

```
<<<<<<< Updated upstream
curl -X POST --location "<https://salt-api-dev.getsalt.ai/api/v1/deployments/7824a62e-8222-454d-9ef4-bf1c7746fed4/executions/>" \\
-H "Content-Type: application/json" \\
=======
curl -X POST --location "<https://salt-api-dev.getsalt.ai/api/v1/deployments/7824a62e-8222-454d-9ef4-bf1c7746fed4/executions/>"
-H "Content-Type: application/json"
>>>>>>> Stashed changes
-d '{ "callback": "<CALLBACK URL>" }'
```

Expand Down Expand Up @@ -57,11 +52,7 @@ When the CURL command and the respective object are executed, you will receive t

## SaltInput node

<<<<<<< Updated upstream
The `SaltInput` node is an official node developed by the Salt team. Each one present in the workflow allows you to expose input parameters for the end user to interact with.
=======
The `SaltInput` node allows you to expose input parameters for end-user interaction within your workflow. Each one represents an input property in the `workflow_input` object of your API call's request body.
>>>>>>> Stashed changes

<aside>
ℹ️ It is recommended to give each SaltInput node a unique name for easier reference when constructing your request body. If a node is unnamed, it will be named by its node id number, e.g. "14".
Expand All @@ -75,11 +66,7 @@ The `SaltInput` node allows you to expose input parameters for end-user interact

## Receiving a response via webhook

<<<<<<< Updated upstream
As workflow run time can vary from seconds to minutes, the output will not be available immediately. To retrieve the final result, make sure to provide a `<CALLBACK URL>` webhook in the request body for us to call when the results are ready.
=======
Workflow run times can vary from seconds to minutes. To manage this, Salt delivers results asynchronously via a webhook. Provide a callback URL to receive the final results once they are ready.
>>>>>>> Stashed changes

### Example response

Expand Down
8 changes: 0 additions & 8 deletions docs/deploy-to-discord.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,7 @@ In any server with the Salt AI bot added, use the `/workflows` command to open t

![discord3](images/discord3.png)

<<<<<<< Updated upstream
Once your workflow is selected, click `Run workflow` to execute it. You can then fill in the workflow's input values, one for each SaltInput node in your workflow. Enter your string & integer values and click `Submit`. If the workflow has image or file attachments, you will be prompted to upload them in your direct messages.
=======
Once your workflow is selected, click `Run workflow` to execute it. You can then fill in the workflow's input values, one for each `SaltInput` node in your workflow. Enter your string & integer values and click `Submit`. If the workflow has image or file attachments, you will be prompted to upload them in your direct messages.
>>>>>>> Stashed changes
Once the required inputs are filled in, your workflow will execute, and the outputs will appear in the thread or channel where you posted your message when they are finished generating.

![discord4](images/discord4.png)
Expand All @@ -49,11 +45,7 @@ Then, head to the **[#flow-catalog](https://discord.gg/FcbmPDf3E7)** channel and

## Troubleshooting errors

<<<<<<< Updated upstream
Sometimes, executions can fail based on errors in the workflow, such as invalid API keys. To fix this, you may have to make adjustments to the workflow, or get in touch with our support team for help.
=======
Sometimes, executions can fail based on errors in the workflow, such as invalid API keys. To fix this, you may have to make adjustments to the workflow, or [get in touch with our support team](https://discord.com/channels/1151592612525002822/1212167911771217961) for help.
>>>>>>> Stashed changes
Connection errors may also result in failed generation, or results that won't return even if the workflow is valid. In this case, you can `right-click` (or tap-hold on mobile) > `Apps` and select `Retry`. The execution will be run again, and could return a successful result if the issue was related to connection.

## Need help?
Expand Down

0 comments on commit da0cbe8

Please sign in to comment.