Skip to content

Commit

Permalink
docs: removed services page, edited title and config
Browse files Browse the repository at this point in the history
  • Loading branch information
claudfuen committed Jan 3, 2024
1 parent bac68be commit 54846b7
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 130 deletions.
61 changes: 1 addition & 60 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,63 +49,4 @@ If you've specified a `webhook_url` when submitting your run, this object will a
}
```

This document should help you navigate and access Leap's new workflows. Feel free to contact us if you encounter issues or have additional questions.

## Understanding Actions

When building a workflow on Leap you can create different types of actions, actions are essentially integrations on top of services which allow you to call each service with full flexibility while still benefiting.

Currently Leap supports OpenAi, Astria, and Replicate.

The schema for each of the services follows the following structure:

``` json copy
{
"pathParams": {
"key": "string"
},
"queryParams": {
"key": "string"
},
"body": {
"key": "string/number/array/object"
}
}
```

Most services only require passing `body` into the object, and Leap handles setting the rest.

Depending on the service you choose, you may also need or want to provide `pathParams` or `queryParams`.

We purposefully keep this interface low-level to give you flexibility when interacting with services as these are constantly updated.

## The Http Utility

If you want to call a service outside of the ones that Leap provides, you will likely resort to the `HTTP Utility` action. This action enables you to call any HTTP endpoint you wish.

The interface is very similar to actions, but with the addition of the `url` and `method` and `headers` options.

``` json copy
{
"url": "someapp.com/api",
"method": "POST",
"headers": {
"key": "string"
},
"pathParams": {
"key": "string"
},
"queryParams": {
"key": "string"
},
"body": {
"key": "string/number/array/object"
}
}
```

## On Service Webhooks

Its important to note that if a service accepts a webhook in the aciton body (e.g. Replicate), Leap workflows makes use of this value. And will ignore your value override it regardless of what you pass in the `body`.

This is because webhooks need for the Leap engine to be aware of job completions. If you'd like to retrieve results, simply provide your `webhook url` when calling the Leap SDK or API, and not as part of step configurations.
This document should help you navigate and access Leap's new workflows. Feel free to contact us if you encounter issues or have additional questions.
65 changes: 0 additions & 65 deletions docs/leap-services.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/webhooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🔗 Webhooks
# Webhooks

Leap workflows currently supports two versions of webhooks, with v2 being the latest.

Expand Down
4 changes: 0 additions & 4 deletions konfig.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ portal:
path: docs/README.md
- id: webhooks
path: docs/webhooks.md
- label: Leap Services
links:
- id: leap-services
path: docs/leap-services.md
socials:
website: https://tryleap.ai/
generators:
Expand Down

0 comments on commit 54846b7

Please sign in to comment.