feat: Added async api docs #174

tinkering-bhatia · 2025-03-19T13:22:16Z

https://app.devrev.ai/devrev/works/ISS-154393

github-actions · 2025-03-19T13:23:23Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email support@ekline.io.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 304 in c2caea9

- Display the final agent response to the user

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 305 in c2caea9

- Handle any errors

🚫 [EkLine] _{reported by reviewdog 🐶}

'Talk To Agent Node in Workflows' should use sentence-style capitalization. (EK00037)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 373 in c2caea9

### Talk To Agent Node in Workflows

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 384 in c2caea9

1. Add the "Talk To Agent" node to your workflow

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 385 in c2caea9

2. Configure it with your agent ID

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 386 in c2caea9

3. Connect it to response nodes to process the agent's output

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 387 in c2caea9

4. The async API is used automatically by the workflow engine

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 399 in c2caea9

- One to trigger the agent asynchronously

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/interact_agent.mdx

Line 400 in c2caea9

- One to handle agent response events

github-actions · 2025-03-19T13:23:57Z

Published docs preview URL: https://devrev-preview-234aa1fd-7b60-4a09-b4f6-9dcaa90b04f6.docs.buildwithfern.com

github-actions · 2025-03-19T13:28:33Z

Published docs preview URL: https://devrev-preview-b55d3640-b3aa-48be-8fcd-084ed0386528.docs.buildwithfern.com

github-actions · 2025-03-19T13:38:11Z

Published docs preview URL: https://devrev-preview-1cfea4fe-f469-4dbd-802c-2b51f3d77615.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-03-19T13:40:19Z

Published docs preview URL: https://devrev-preview-20dc8503-8968-42fb-ad2b-9ba4da622661.docs.buildwithfern.com

…nto guide/agent-async

github-actions · 2025-03-19T13:52:50Z

Published docs preview URL: https://devrev-preview-7543142d-a237-4ad6-9484-4e1f18e611cc.docs.buildwithfern.com

kpsunil97

LG

fern/versions/beta.yml

fern/docs/pages/interact_agent.mdx

…nt-async

fern/docs/pages/interact-agent.mdx

github-actions · 2025-03-20T08:15:47Z

fern/docs/pages/interact-agent.mdx

+}
+```
+
+### 3. Error Message


🚫 [EkLine] _{reported by reviewdog 🐶}

'3. Error Message' should use sentence-style capitalization. (EK00037)

github-actions · 2025-03-20T08:16:09Z

Published docs preview URL: https://devrev-preview-48322b76-c3ae-4753-b0e1-0eb9a8b31b09.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…nto guide/agent-async

github-actions · 2025-03-20T10:00:22Z

Published docs preview URL: https://devrev-preview-9f43139e-54ac-40ec-b6e2-23425ae3f18a.docs.buildwithfern.com

bc-devrev

Approved with a couple superficial corrections.

bc-devrev · 2025-03-20T17:23:31Z

fern/docs/pages/interact-agent.mdx

@@ -0,0 +1,371 @@
+This cookbook provides a step-by-step guide to use the asynchronous API for DevRev agents. It assumes you've already created an agent using the DevRev agent builder platform.
+
+This DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:


Suggested change

This DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:

The DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:

bc-devrev · 2025-03-20T17:25:43Z

fern/docs/pages/interact-agent.mdx

+  In any unlikely and unforeseen circumstances, if an individual operation of the workflow times out, you do not receive an error event right now to notify that you should not wait for any more messages. It is better to have a client side timeout for now while the issue is brainstormed and fixed for you. 
+</Callout>
+
+## Setting up webhook


No gerunds in titles. https://www.notion.so/devrev/How-should-instructions-be-written-dac658b248d94db6a0c301079cffbbf5?pvs=4

Suggested change

## Setting up webhook

## Set up webhook

bc-devrev · 2025-03-20T17:26:33Z

fern/docs/pages/interact-agent.mdx

+  across multiple calls.
+</Callout>
+
+## Handling webhook events


Suggested change

## Handling webhook events

## Handle webhook events

bc-devrev

Approved with a couple superficial corrections.

Added async api docs

c2caea9

tinkering-bhatia requested a review from nimit2801 March 19, 2025 13:22

tinkering-bhatia requested a review from a team as a code owner March 19, 2025 13:22

github-actions bot reviewed Mar 19, 2025

View reviewed changes

remove snap in docs

3290df1

Resolve auto gen comments

d91e7b1

Update fern/docs/pages/interact_agent.mdx

ea6b3ac

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

tinkering-bhatia requested review from kpsunil97, bc-devrev and bdbyrne March 19, 2025 13:39

tinkering-bhatia added 2 commits March 19, 2025 19:21

remove tabs

d0daa8c

Merge branch 'guide/agent-async' of github.com:devrev/fern-api-docs i…

3cf5e2a

…nto guide/agent-async

tinkering-bhatia mentioned this pull request Mar 19, 2025

Add DevRev Agents Async API Cookbook documentation #170

Closed

kpsunil97 approved these changes Mar 19, 2025

View reviewed changes

bc-devrev requested changes Mar 19, 2025

View reviewed changes

tinkering-bhatia added 2 commits March 20, 2025 13:44

resolve all comments

8ea3ff9

Merge branch 'main' of github.com:devrev/fern-api-docs into guide/age…

3b0ccc5

…nt-async

github-actions bot reviewed Mar 20, 2025

View reviewed changes

tinkering-bhatia and others added 3 commits March 20, 2025 15:25

Update fern/docs/pages/interact-agent.mdx

1fc746b

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

resolve autogen comments

6775058

Merge branch 'guide/agent-async' of github.com:devrev/fern-api-docs i…

bf3c64f

…nto guide/agent-async

bc-devrev reviewed Mar 20, 2025

View reviewed changes

bc-devrev approved these changes Mar 20, 2025

View reviewed changes

nimit2801 merged commit 3011aa4 into main Mar 20, 2025
3 checks passed

nimit2801 deleted the guide/agent-async branch March 20, 2025 17:38

tinkering-bhatia mentioned this pull request Mar 21, 2025

fix: resolve comments from last PR of adding agents async API guide #177

Merged

		@@ -0,0 +1,371 @@
		This cookbook provides a step-by-step guide to use the asynchronous API for DevRev agents. It assumes you've already created an agent using the DevRev agent builder platform.

		This DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:

	This DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:
	The DevRev async API enables you to execute agents without any execution timeout concerns. The execution occurs as an asynchronous workflow that sends events to you via webhooks. This approach ensures:

feat: Added async api docs #174

feat: Added async api docs #174

Uh oh!

Conversation

tinkering-bhatia commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

github-actions bot commented Mar 19, 2025

Uh oh!

kpsunil97 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

bc-devrev Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

bc-devrev Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

bc-devrev Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 19, 2025 •

edited

Loading